Harjoitus – Luo ensimmäinen pull-pyyntösi

  • 6 minuuttia

Olet oppinut, miten pull-pyyntö luodaan, kun pull-pyyntömallissa tai CONTRIBUTING-tiedostossa on ohjeita. Entä jos projekti ei tarjoa ohjeita ja ohjeita käytäntöihin?

Muutosten kuvaileminen

Voit kirjoittaa hyvän vahvistusviestin ja myöhemmin pull-pyynnön noudattamalla seuraavia käytäntöjä:

  • Git-vahvistusviestin aiherivin tulee täyttää seuraava lause:
    • Jos tämä vahvistus on käytössä, se <your subject line here>.
  • Lisää ytimekittainen kuvaus muutoksesta käyttämällä imperatiivista, nykyistä aikamuotoa. Voit esimerkiksi lisätä lisäämättä lisättyä tai lisää.
  • Rajaa aiheriville 50 merkkiä.
  • Aloita isolla kirjaimella, älä pääty pisteeseen (.).
  • Voit käyttää emojia tai @mention muita GitHub-käyttäjiä otsikkorivilläsi, mutta muista, että kaikki projektit eivät salli tai kannusta tätä.

Käytä viestin tekstiosassa ja pull-pyynnössä jatkossakin nykymuodossa. Muista sisällyttää muutoksen motivaatio. Verrata muutosta edelliseen toimintaan. Voit käytettävissäsi olevan tilan avulla selittää , mitä ja miksi ja miten.

Vahvistusviestisi on vain niin tärkeä kuin sisältö, jonka olet lähettämässä. Vahvista tai lähetä tarkistettavaksi pienet, eristetyt muutosjoukot. Tämä käytäntö kasvattaa todennäköisyyttä, että muutoksesi yhdistetään projektiin.

Askelvälin lisääminen

Ennen kuin lähetät pull-pyynnön, tarkista sivupalkista tapoja pull-pyynnön suorittamiseen. Valitse Tarkistajat tai Määritä, jos olet tutustunut projektin tiimin rakenteeseen. Lisää otsikoita, kun selitteiden käytöstä on ohjeita esimerkiksi CONTRIBUTING.md tiedostossa. Voit käyttää tunnisteita visuaalisena vihjeenä siitä, mitä yrität saavuttaa. Ylläpitäjä voi myös lisätä otsikon tai useita otsikoita.

Juomaraha

Jos säilössä on CONTRIBUTING.md tiedosto tai PR-malli, noudata sen ohjeita, kun täytät pull-pyyntöä.

Tämän Learn-moduulin säilössä käyttämiämme tunnisteita ovat esimerkiksi seuraavat:

  • Ohjelmavirheen (punainen): Jokin ei toimi
  • Documentation (sininen): Parannuksia tai lisäyksiä dokumentaatioon
  • kaksoiskappale (harmaa): Tämä ongelma tai pull-pyyntö on jo olemassa
  • Enhancement (teal): Uusi ominaisuus tai pyyntö

Vaihtoehtoisesti voit linkittämisongelmia sivupalkissa, jossa pull-pyynnön yhdistäminen onnistuneesti saattaa sulkea vastaavan ongelman. Voit myös mukauttaa tilauksesi niin, ilmoitukset ketjussa. Jotkin PR:t saavat useita kommentteja, arvosteluja ja CI/CD:hen liittyviä ilmoituksia. Voit valita esimerkiksi seuraavaa:

  • Ei tilattu: vastaanota ilmoituksia vain, kun olet osallistunut tai @mentioned
  • Tilattu: Vastaanota kaikki ilmoitukset tästä pull-pyynnöstä
  • Mukautettu: saa ilmoituksen vain valitsemistasi tapahtumista

Harjoitus

First Contributions -projektin käyttö, käytäntö pull-pyynnön luomiseen, kloonaamiseen ja lähettämiseen. First Contributions -hankkeen tavoitteena on "ohjata sitä, miten aloittelijat antavat ensimmäisen panoksensa". Siinä on ohjeita sekä komentorivin käyttämiseen että useisiin graafisiin käyttöliittymisiin. Projektilla on myös tuki useille kielille. Varmista, että tarkistat Translations-kansion.

Edellisen ja tämän osion oppituntien ansiosta voit palata hiljattain avaamaani pull-pyyntöön. Voit myös siirtyä katselemasi projektin Pull-pyynnöt-välilehteen. Huomaa, miten hyvällä aiherivillä voi olla merkitystä. Harkitse pull-pyynnön päivittämistä vastaavasti. Käytät suunnilleen yhtä paljon aikaa pull-pyyntösi kirjoittamiseen kuin projektiin tehtyjen muutosten tekemiseen. Voit auttaa ylläpitäjiä luokittelemaan ja priorisoimaan yhteisön työpanoksia.

bonus: Tarkista Microsoftin helppokäyttöisyysohjeet ja -vaatimukset. Tutustu erityisesti koskeviin tietoihin, jotka kuvaavat vuorovaikutusta käyttöliittymän, jotta vältät kielitaitojen lisäämisen. Asiakkaat käyttävät tuotteita eri syöttömenetelmillä. He voivat esimerkiksi käyttää esimerkiksi näppäimistöä, hiirtä, kosketusnäyttöä ja ääntä. Haluat käyttää yleisiä verbejä, jotka toimivat missä tahansa syötemenetelmässä. Käytä esimerkiksi valitse syötekohtaisen sijaan napsauta tai pyyhkäise.