Avoimen lähdekoodin säilöön osallistuminen

Valmis

Kun olet tunnistanut alueen, johon voit osallistua, seuraava vaihe on panoksesi valmistelu. Tässä tarkistamme, miten voit kertoa aikomuksestasi osallistua projektiin, luoda pull-pyyntö ja parantaa mahdollisuuksiasi saada se hyväksytyksi.

Tietoliikenne on tärkeä onnistumistekijä avoimen lähdekoodin projektiin osallistumisessa. Voi olla epämiellyttävää olla yhteydessä muihin ehdottamistasi muutoksista tai parannuksista. Tämä vuoropuhelu johtaa usein keskusteluihin ja kompromisseihin alkuperäisestä visiostasi.

Aktiivisen viestinnän välttäminen avoimen lähdekoodin projektiin osallistuvien kanssa vaarantaa aikasi sellaisten tehtävien parissa, joita joku muu jo työstää. Saatat myös työstää ominaisuuksia tai parannuksia, jotka eivät vastaa projektin arvoja tai parhaita käytäntöjä. Kummassakin tapauksessa kaikkien aika menee hukkaan. Sitä vastoin sitoutumalla aktiiviseen viestintään varmistetaan, että työsi otetaan hyvin vastaan ja että se vaikuttaa paljon.

Miten voit varmistaa onnistumisen, kun olet yhteydessä projektin muiden jäsenten kanssa uusista ominaisuuksista ja muutoksista? Yritä ensin pitää mieli avoimena. Ole avoin palautteelle ja harjoita kärsivällisyyttä. Avoimen lähdekoodin projektien ylläpitäjillä on todennäköisesti päivätyö ja yksityiselämä. Jos et saa vastausta heti, odota hieman kauemmin, ennen kuin pingaat ylläpitäjille.

Kerro aikeesi ylläpitäjille

Sinun tulee aina aloittaa ilmoittamalla aikomuksestasi osallistua ennen varsinaisia töitä. Ellei README-tiedostossa ole toisin mainittu, ongelman seuranta on yleensä paras paikka sille.

• Jos haluat käsitellä aiemmin luotua ongelmaa, tarkista, ettei sille ole määritetty ketään. Tutustu Määritä -osioon. Tarkista myös Linkitettyjen pull-pyyntöjen -osa. Linkitetty pull-pyyntö tarkoittaa, että joku on jo työstänyt sitä. Käy läpi kommentit nähdäksesi, ilmoittiko joku kiinnostuksensa työskennellä asian parissa. Jos kaikki on selvää, julkaise kommentti asiasta ja ilmaise kiinnostuksesi työskennellä sen parissa. Siten kerrot ihmisille, jotka saattavat myöhemmin tulla, että joku työskentelee asian parissa. Lisäksi ylläpitäjät voivat tarvittaessa vastata sinulle opastuksella ja neuvoilla.

  

• Jos haluat työstää uutta ominaisuutta tai ohjelmistovirhettä, jota ei vielä ole ongelman seurannassa, luo uusi ongelma. Muista noudattaa asiaa koskevaa mallia, jos sellaista ehdotetaan, ja ilmaise selkeästi aikeesi käsitellä asiaa. Jos kyseessä on uusi ominaisuusehdotus tai jos ongelma vaatii useita muutoksia, varmista, että saat ylläpitäjien hyväksynnän ennen seuraavaan vaiheeseen siirtymistä.

Pull-pyynnön luominen GitHub-säilöön

Kun olet ilmoittanut aikeestasi auttaa projektia, olet nyt valmis aloittamaan varsinaisen työpanoksesi työstämisen.

Työpanoksesi on pullpyyntö, tai pull. Pull-pyyntö on GitHubissa erityinen paikka, joka sisältää muutamia asioita:

• Otsikko ja kuvaus muutoksille.
• Yksi tai useampi vahvistus, joka muodostaa ehdottamasi muutokset.
• Kommentit, joissa kaikki voivat osallistua muutoksia koskeviin keskusteluihin.
• Koodin arviointeja, joista löydät yksityiskohtaista palautetta muutoksistasi ja lopulta vahvista ehdotuksia.
• Tilatarkistukset ovat peräisin esimerkiksi automaattisista testeistä, joita ylläpitäjät ovat saattaneet tehdä. Tilatarkistukset voivat palvella eri tarkoituksia. He voivat esimerkiksi varmistaa, että muutoksesi noudattavat projektin sääntöjä tai että muutoksesi eivät riko koodia.

Kun pull-pyyntö on luotu, se voidaan päivittää uusilla vahvistuksilla, kommenteilla tai koodin tarkistuksilla. Tämä prosessi jatkuu, kunnes projektin ylläpitäjät hyväksyvät ja yhdistävät pull-pyynnön tai hylkäävät muutokset ja sulkevat pull-pyynnön. Kun pull-pyyntö yhdistetään, muutokset on integroitu projektin koodikantaan.

Pull-pyynnön luominen vaihe vaiheittain

1. Avaa sen projektin GitHub-sivu, johon haluat osallistua.

2. Luo kopio GitHub-tilisi säilöstä valitsemalla Fork -painike. Tämä vaihe on välttämätön, koska sinulla ei ole oletusarvoisesti oikeuksia tehdä muutoksia julkiseen säilöön, ellei se ole oma kopiosi. Luomalla projektin luot kopion, johon voit tehdä muutoksia.

   

3. Valitse Tilisi profiilivalikosta säilösi.

   

4. Valitse säilön haarautuvuus.

5. Valitse Code -painike, niin saat tietoja Git-säilön kloonaamisesta paikalliseen koneeseen.

   

6. Valitse leikepöydän -kuvake säilön URL-osoitteen kopioimiseksi ja kirjoita sitten päätteeseen:

   git clone <REPOSITORY_URL>
   

   Tämä komento luo säilön kopion paikallisessa tietokoneessa.

   Vaihtoehtoisesti voit käyttää GitHub Desktop -, jos haluat käyttää sovellusta. Voit myös käyttää GitHub Codespaces -, jos olet ehdottanut tätä vaihtoehtoa. Jos olet Visual Studio Code -käyttäjä, GitHub Codespaces on sinulle tuttu.

7. Kun projekti on kloonattu, syötä projektikansio:

   cd <PROJECT_FOLDER>
   

8. (Valinnainen) Luo uusi haara käyttämällä seuraavaa komentoa:

   git checkout -b <BRANCH_NAME>
   

   Tämä vaihe ei ole pakollinen, mutta se on erittäin suositeltavaa. Uuden haaran avulla voit työstää useita eri osallistumisia erikseen, kukin käyttämällä eri haaraa.

9. Tee haluamasi muutokset projektiin ja vahvista ne:

   git add .
   git commit -m "<COMMIT_MESSAGE>"
   

   Nämä komennot lavastavat muutokset vahvistusta varten ja luovat sitten vahvistustoiminnon määritetyllä viestillä. Muista kuvailla muutokset oikein vahvistusviestissä. On myös hyvä tarkistaa, onko CONTRIBUTING-tiedostossa maininta vahvistusviestikäytännöistä, joita sinun on noudatettava.

10. Lähetä muutokset etäkomentoon -komennolla:

    git push --set-upstream origin <BRANCH_NAME>
    

    Tämä komento luo uuden haaran yläpuoliseen säilöön GitHubissa (haaraumaan) ja lähettää kaikki vahvistuksesi siihen.

    Muistiinpano

    Kun puhutaan ylätason säilöstä, viittaamme paikalliseen säilöösi linkitettyyn etäsäilöön. origin on säilön URL-osoitteen oletusalias, jonka Git loi vaiheessa 4.

    Jos et ole luonut haaraa aiemmin, syötä vain git push.

11. Avaa projektihaaru GitHubissa ja valitse Vertaa & pull-pyyntö -painike näkyviin tulevasta ehdotusruudusta.

    

12. Täytä otsikko ja kuvaus ja valitse Luo pull-pyyntö -.

    

    Jos pull-pyynnön kuvaukselle on malli, täytä kaikki tarvittavat tiedot. Jos sellaista ei nyt ole, varmista, että annat ylläpitäjille tarpeeksi kontekstia, jotta he ymmärtävät, mitä muutoksia olet ehdottanut ja miksi. Linkitä myös takaisin aiheeseen liittyvään ongelmaan mainitsemalla sen numero käyttämällä #<ISSUE_NUMBER>. Ongelman numero on sen otsikon vieressä.

    

Tilatarkistusten läpäiseminen

Kun olet luonut pull-pyynnön, saatat nähdä osan, jonka alareunassa on tilatarkistuksia, kuten:

Nämä tilatarkistukset ovat automaattisia tarkistuksia, jotka ylläpitäjät ovat tehneet projektin tasaisen laadun varmistamiseksi.

Pull-pyynnön hyväksyminen edellyttää, että se läpäisee kaikki automaattiset tarkastukset. Jos jokin epäonnistuu kuten edellisessä näyttökuvassa, valitse Tiedot -painike saadaksesi lisätietoja virheestä ja selvittääksesi, mitä sinun on tehtävä sen korjaamiseksi.

Jos et ole varma, mitä tehdä epäonnistuneella tarkastuksella, voit aina kommenteilla kysyä ylläpitäjien ohjeita tai auttaa korjaamaan sen.

Pyydä ohjeita tai arvosteluja pull-pyynnöistä

Et ehkä ole varma joistakin muutoksista, jotka olet tehnyt, ja haluat saada ylläpitäjien mielipiteet. Paras tapa tehdä se on kommentoida suoraan pull-pyyntöjä. Jos pidät tekemiäsi muutoksia keskeneräisinä, voit myös luoda pull-pull-pyynnön pyytää ohjeita tai apua muilta osallistujilta.

Kun projektin ylläpitäjät ovat tulleet pull-pyyntösi perusteella, he voivat vastata keskusteluun tai tarkistaa muutoksesi suoraan. Pull-pyynnön tarkistuksen jälkeen on useita mahdollisia tuloksia:

• Muutoksesi hyväksytään. Onnittelen!
• Pull-pyyntö edellyttää joitakin muutoksia. Älä lannista. Tarkastele annettua palautetta lähemmin. Jos teet pyydetyt muutokset, pull-pyyntö hyväksytään. Jos lähetät uusia vahvistuksia haaraasi, pull-pyyntö päivittyy automaattisesti uusilla muutoksilla.
• Tarkistaja kommentoi asiaa. Se tarkoittaa yleensä sitä, että tarvitsemme enemmän yksityiskohtia muutoksistasi tai sen taustalla olevasta motivaatiosta.

Pull-pyyntöön vastaaminen kommentteihin

Muista olla aina kunnioitettava kaikissa vaihdoissasi ja noudattaa käyttäytymissääntöjä. On todennäköistä, että ennen kuin muutoksesi hyväksytään, käydään parhaillaan keskustelua ylläpitäjien tai muiden osallistujien kanssa.

Vaikuttaminen avoimeen lähdekoodiin vaatii kärsivällisyyttä. Joskus et saa välitöntä palautetta. Älä ota yhteyttä ylläpitäjiin yksityisesti sähköpostitse, X:llä tai millä tahansa muulla tavalla toivoen saavasi vastauksen nopeammin. Tätä käyttäytymistä pidetään haitallisena. Julkisesti keskusteleminen antaa myös muille osallistujille tai ohikulkijoille mahdollisuuden oppia muutosten taustalla olevasta prosessista ja parhaista käytännöistä.