Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (81 loc) · 6.01 KB

CONTRIBUTING.md

File metadata and controls

108 lines (81 loc) · 6.01 KB
Raw

Ohjeet sivuston kehitykseen osallistumiseen

Suosittelemme lukemaan tämän ohjeen ennen sivuston kehitykseen osallistumista.

Kuinka voin osallistua?

Voit osallistua sivuston kehitykseen monella tavalla. Voit esimerkiksi:

Ilmoita virheistä

Jos huomaat sivustolla virheen, bugin tai muuta korjattavaa, voit ilmoittaa siitä tekemällä issuen GitHubin / Codebergin Issues-osiossa. Virheen korjaamiseksi helpottamiseksi kannattaa täyttää kaikki kohdat mahdollisimman tarkasti. Ylläpito auttaa virheilmoituksen tekemisessä tarvittaessa.

Korjaa virheitä

Jos osaat ja haluat korjata virheen itse, voit tehdä sen tekemällä pull requestin GitHubin / Codebergin Pull requests-osiossa. Lisää pull requestiin issue numero, johon pull request liittyy. Kun pull request on valmis, ylläpito tarkistaa sen ja joko pyytää muutoksia tai hyväksyy sen.

Ehdota uusia ominaisuuksia

Jos haluat ehdottaa uutta ominaisuutta, voit tehdä sen tekemällä issuen GitHubin / Codebergin Issues-osiossa. Ominaisuuksia voi ehottaa vaikka ei itse osaa tai halua niitä toteuttaa.

Kehittää uusia ominaisuuksia

Ennen kuin aloitat uuden ominaisuuden toteuttamisen, kannattaa kuitenkin luoda siitä ehdotus issuen muodossa, jotta voimme keskustella sen tarpeellisuudesta ja toteutustavasta.

Tule mukaan ylläpitoon

Jos haluat tulla mukaan ylläpitoon, voit lähettää vapaamuotoisen järjestelmätoimikuntahakemuksen ylläpidolle yllapito@serveriry.fi tai vaikka telegrammissa. Kerro hakemuksessa vähän itsestäsi, osaamisestasi ja siitä, mitä haluaisit tehdä järjestelmätoimikunnassa. Lähtökohtaisesti kaikki halukkaat pääsevät mukaan, eikä se sido sinua mihinkään. Tule rohkeasti mukaan kehittämään omia taitojasi ja Serveri ry:n infrastruktuuria.

Kehitysympäristön pystytys ja käyttö

Ohjeet kehitysympäristön pystyttämiseen löytyvät README.md-tiedostosta.

Muutosten tekeminen

  1. Tee issue uudesta ominaisuudesta tai virheestä, jonka haluat korjata tai valitse joku olemassa oleva issue, johon haluat tehdä muutoksia. Tarkista, ettei samasta asiasta ole jo tehty issueta.
  2. Forkkaa tämä repo omalle GitHub käyttäjällesi. Tämä luo reposta kopion omalle käyttäjällesi. Voit muokata luotua repoa ilman, että se vaikuttaa alkuperäiseen.
    • Forkataksesi repon, paina Fork nappulaa sivun oikeassa yläkulmassa tai paina tästä.
  3. Aseta ympäristömuuttujat oikein, yleensä tarvitsee määrittää vain apin osoite (https://api.serveriry.fi/)
  4. Kloonaa forkkaamasi repo omalle koneellesi

    • Käytä komentoa

      git clone https://github.com/<your-user-name>/community-standards.git
  5. Tee muutokset ja committaa ne kuvaavalla commit viestillä. Varmista koodin laadukkuus.

    • Varmista, että koodisi on laadukasta eli formatoitu oikein eikä sisällä onglemia.

    • Käytä lyhyitä ja kuvaavia englannin kielisiä commit viestejä, katso jonkun näkemys hyvästä commit viestistä.

      git commit -m "fix: overflowing text"
  6. Puske muutoksesi omaan forkattuun repoosi.

    • Käytä komentoa

      git push origin your-branch-name
  7. Lähetä pull requesti alkuperäiseen repoon.
    • Pull requestin luomiseksi käytä seuraavia vaiheita.
      1. Mene forkkaamaasi repoon.
      2. Paina Compare & pull request nappulaa sinun-branch-nimi-branchin vieressä.
      3. Kirjoita otsikko ja kuvaus pull requestillesi.
      4. Paina Create pull request ja valitse sopivat "labelit" oikeaan reunaan, kuten bug tai enhancement.
  8. Kun pull request on lähetetty, ylläpito tarkistaa sen ja joko pyytää muutoksia tai hyväksyy sen.

Jos tarvitset missään vaiheessa apua tai neuvoja, voit kysyä niitä GitHubin / Codebergin Issues-osiossa tai suoraan ylläpidolta, esimerkiksi telegram yksityisviestillä. Yhteystiedot löytyvät serveriry.fi/tietoa-sivusta-sivulta.

Laadukkaan koodin kirjoittaminen

Koodin laatu on tärkeää, jotta koodia on helppo ylläpitää ja kehittää. Tässä muutamia vinkkejä laadukkaan koodin kirjoittamiseen:

  • Projektin kielenä on englanti, käytä sitä muuttujien ja funktioiden nimissä, kommentoinnissa ja commit viesteissä.
  • Kommentoi koodia aina kun se on tarpeellista. Kommentit auttavat muita ymmärtämään koodia ja nopentavat koodin ylläpitoa. Vältä kuitenkin itsestäänselvyyksien kommentointia.
  • Käytä koodin muotoiluun Prettier-työkalua. Prettier muotoilee koodin automaattisesti yhtenäiseen muotoon, jolloin koodin muotoilusta ei tarvitse huolehtia itse. Prettierin asetukset löytyvät .prettierrc-tiedostosta. Suositeltavaa on lisätä Prettier suoraan editoriin, jotta koodin muotoilu tapahtuu automaattisesti.
  • Käytä koodin tarkistukseen ESLint-työkalua. ESLint tarkistaa koodin automaattisesti yleisimmät virheet ja varoittaa niistä. ESLintin asetukset löytyvät .eslintrc-tiedostosta.
  • Tarkista että koodisi ei aiheuta virheitä tai varoituksia. Jos koodi aiheuttaa virheitä tai varoituksia, korjaa ne.

Code of Conduct

Kaikkien projektin osallistujien tulee noudattaa Serveri ry:n turvallisen tilan periaatteita.