Haluatko parantaa mainettasi GitHubissa? Näin muotoillaan sitoutumisviestit.
Sen sijaan, että kirjoittaisit yhden rivin git-viestin, sitoutua -m Vaihtoehto, tässä artikkelissa opitaan kirjoittamaan oikeat sitoutumisviestit. Oikea sitoutumisviesti on tärkeä, koska sen avulla muut näkevät tarkalleen mitä olet muokannut, projektisi helpottaminen muiden seuraamiseksi auttaa lisäämään altistumistasi avoimelle lähdekoodille Yhteisö.
Kirjoita oikea sitoutumisviesti
Sen sijaan, että sisällytät sitoutumisviestin terminaalikomentoon, avaa suosikkisi tekstieditori tyhjään tiedostoon. Sanoman tulee olla seuraavan muodon mukainen:
Etsitkö päätelaitteen tekstieditoria Linuxille? Tärkein valinta on Vimin ja nanon välillä! Näin he vertailevat.
- Ensimmäinen rivi on otsikko, joka sisältää yhteenvedon koko sitoutumisesta.
- Tyhjän rivin jälkeen seuraavan tai useamman rivin tulee olla mikä tahansa luettavissa oleva kuvaus, joka tarvitaan sitoutumiseen. Tämä voi olla niin kauan kuin halutaan.
- Kaikkien seuraavien rivien tulisi tiivistää koodiin tehdyt tarkat muutokset tällaisessa muodossa:
- Tiedostonimi: Rivi # - Lyhyt kuvaus muutoksesta.
Esimerkki sitoutumisviestistä
Alla on esimerkki sitoutumisviestistä:
Lisätty Docker-tuki, uusi is_unique-ominaisuus ja virhekorjaus.
Lisätty tuki telakointikomennoille ja päivitetyt asennusohjeet tarvittaessa. Sisällytti myös uuden ominaisuuden check_order () -toimintoon yksilöllisyyden tarkistamiseksi ja kiinteän pienen virheen tuotetyynyjen luomisessa.
src / somedir / library.py: 381 - Lisätty parametri 'is_unique' check_order () -toimintoon.
src / products.py: 194 - Korjattu vika tuotteen etanan luomisessa.
docker-compose.yml - Lisätty docker-compose-tiedosto.
docs / install.md - Päivitetty asennusopas, joka sisältää asennuksen Dockerin kautta.
Suorita viesti
Kun teet sitoumuksen nyt, sen sijaan, että käyttäisit -m käytä viestiä--tiedosto vaihtoehto. Jos esimerkiksi sitoutumisviestisi tiedostonimi on pühend.txt, suoritat komennon:
git sitoutua - tiedosto sit.txt
Siinä kaikki siinä on! Toivottavasti tämä auttaa sinua toimittamaan standardoidumpia ja selkeämpiä sitoutumisviestejä seuraajillesi, mikä auttaa projektiasi saamaan näkyvyyttä ja auttamaan avoin lähdekoodi yhteisö kasvaa.
Kuvahyvitys: Caleb White /Irrota
Haluatko jakaa kehityshankkeesi verkossa? Näin pääset alkuun ensimmäisen Github-arkiston kanssa.
- Ohjelmointi
- GitHub
Tilaa uutiskirjeemme
Liity uutiskirjeeseemme, jossa on teknisiä vinkkejä, arvosteluja, ilmaisia e-kirjoja ja erikoistarjouksia!
Vielä yksi askel !!!
Vahvista sähköpostiosoitteesi juuri lähettämässäsi sähköpostiviestissä.