Kuidas kirjutada häid kohustusi sisaldavaid sõnumeid: praktiline Git-juhend

Kasuliku redaktsiooniajaloo loomiseks peaksid meeskonnad kõigepealt kokku leppima kasutatava pühendumissõnumi konventsioonis. See kehtib ka isiklike projektide kohta.

Hiljuti Hashnode'is küsisin: "Millist pühendumissõnumite konventsiooni te tööl kasutate?" ja sain kasutajatelt hämmastavaid vastuseid, selgitades tööl ja isiklike projektide jaoks kasutatavaid konventsioone.

Millist pühendumissõnumite konventsiooni te tööl kasutate?

saidilt @hashnode //t.co/HewCBxRCbr

- BOLAJI @ (@iambolajiayo) 25. november 2019

Selles artiklis uurin, kuidas kirjutada häid pühendumissõnumeid ja miks peaksite seda tegema.

PS: See artikkel ilmus esmakordselt minu siin blogis.

Sissejuhatus versioonihaldusse Gitiga

Versioonihaldustarkvara on tänapäeva tarkvaraarendajate tavade oluline osa.

Ülekaalukalt on Git maailmas enim kasutatav versioonikontrollisüsteem. See on levitatud ja aktiivselt hooldatud avatud lähtekoodiga projekt, mille algselt arendas 2005. aastal välja Linuxi operatsioonisüsteemi tuuma kuulus looja Linus Torvalds.

Kas olete Giti jaoks uus? Vaadake ametlikku alustamisjuhendit või seda slaidi eelmisest jutust, mille pidasin.

Mis on pühendumissõnum?

Toime Käsku kasutatakse muudatuste salvestamiseks kohalik hoidla pärast staadiumi Git. Enne Giti muudatuste salvestamist peate siiski Gitile ütlema, millised muudatused soovite salvestada, kuna olete teinud palju muudatusi. Suurepärane viis selleks on muudatuste tuvastamiseks pühendumissõnumi lisamine .

Commit Options

  • -m

See valik määrab pühenduse sõnumi.

git add static/admin/config.yml git commit -m "Setup multiple roles for netlify-cms git gateway" 
  • -a või - kõik

See valik seob automaatselt kõik (ka uued) jälgitud, muudetud või kustutatud failid.

git commit -a -m "Add a new role for netlify-cms git gateway" 
  • - muuta

See suvand kirjutab kõige viimase kohustuse ümber kõigi hetkel korraldatud muudatuste või uue pühendamisteatega ja seda tuleks teha ainult nende toimingute korral, mida pole veel kaughoidlasse lükatud.

git add . git commit --amend -m "Update roles for netlify-cms git gateway" 

Miks peaksite kirjutama häid pühendumissõnumeid?

Võite öelda: "See on lihtsalt isiklik projekt." Jah, töötate praegu üksi, kuid mis juhtub siis, kui töötate meeskonnaga või panustate avatud lähtekoodiga?

Hästi vormistatud Giti pühendumissõnum on parim viis muudatuste kohta konteksti edastamiseks teistele selle projektiga töötavatele arendajatele ja tõepoolest ka oma tulevasele minale.

Kas olete kunagi proovinud käia git logühes oma vanas projektis, et näha "imelikke" sooritussõnumeid, mida olete kasutanud selle loomisest saadik? Võib olla raske mõista, miks te varem mingeid muudatusi tegite, ja sooviksite seda artiklit varem lugeda :).

Pühendunud sõnumitega saab adekvaatselt teada anda, miks muudatus tehti, ning mõistmist, mis muudab arendamise ja koostöö tõhusamaks.

Kuidas Gitiga pühendussõnumeid kirjutada

Enne seda kasutasin git commit -m "Fix X to allow Y to use Z"oma isiklikes projektides ainult ainet ja lisakirjeldust. See sobib suurepäraselt väikeste ja selgete paranduste jaoks git commit -m "Fix typo in README.md, kuid ulatuslikumate muudatuste korral peate lisama mõned üksikasjad.

Redaktori meetod

Käivitage git commitilma sõnumi või suvandita ja see avab teie vaiketekstiredaktori pühendussõnumi kirjutamiseks.

"Vaikimisi" redaktori konfigureerimine:

git config --global core.editor nano 

See konfigureeriks Giti kasutama vaiketoimetajana nano. Asendage "nano" sõnadega "emacs", "vim" või mis iganes teie eelistus on.

Avatud redaktoris on esimene rida teema (lühikirjeldus), jätke selle järele tühi rida ja kõik muu on laiendatud kirjeldus (keha).

Käsurea meetod

git commit -m "Subject" -m "Description..." 

Esimene -mvõimalus on teema (lühikirjeldus) ja järgmine on laiendatud kirjeldus (keha).

Kuidas kirjutada häid sõnumeid

Heade pühendumissõnumite kirjutamiseks on erinevad meeskonnad ja arendajad kasutanud mitmeid tavasid. Esitan vaid mõned üldised reeglid ja näpunäited pühendumissõnumite kirjutamiseks - peate otsustama, millist konventsiooni soovite järgida. Ja kui töötate ettevõttes või panustate avatud lähtekoodiga, peate nende tavaga kohanema :).

Järjepidevuse huvides võite kasutada ühte konventsiooni tööks ja teist isiklike projektide jaoks, kuna võite millalgi töökohta vahetada, samuti võib see muutuda.

Vaadake sellest lõimest kindlasti hämmastavaid pühendumissõnumite konventsioone või lisage oma, et aidata kellelgi otsust teha.

Siin on suurepärane mall hea pühendumissõnumi kohta, mille algselt kirjutas Tim paavst

Capitalized, short (50 chars or less) summary More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together. Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert. Further paragraphs come after blank lines. - Bullet points are okay, too - Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here - Use a hanging indent If you use an issue tracker, add a reference(s) to them at the bottom, like so: Resolves: #123 

Näeb hea välja, eks? Siit saate teada, kuidas ka teie oma suurepäraseks muuta:

  1. Määrake kohustuse tüüp:
  • feat: uus funktsioon, mille lisate konkreetsele rakendusele
  • fix: A bug fix
  • style: Feature and updates related to styling
  • refactor: Refactoring a specific section of the codebase
  • test: Everything related to testing
  • docs: Everything related to documentation
  • chore: Regular code maintenance.[ You can also use emojis to represent commit types]
  1. Separate the subject from the body with a blank line
  2. Your commit message should not contain any whitespace errors
  3. Remove unnecessary punctuation marks
  4. Do not end the subject line with a period
  5. Capitalize the subject line and each paragraph
  6. Use the imperative mood in the subject line
  7. Use the body to explain what changes you have made and why you made them.
  8. Do not assume the reviewer understands what the original problem was, ensure you add it.
  9. Do not think your code is self-explanatory
  10. Follow the commit convention defined by your team

Conclusion

Pühendunud sõnumi kõige olulisem osa on see, et see peaks olema selge ja tähendusrikas. Pikas perspektiivis näitab head pühendumissõnumite kirjutamine, kui suur kaastööline sa oled. Heade pühendumissõnumite kirjutamise eelised ei piirdu ainult teie meeskonnaga, vaid laienevad ka teie enda ja tulevaste kaasautorite hulka.

Kas soovite Giti kohta rohkem teada saada ja saada professionaalseks "versioonihalduriks"? Vaadake neid suurepäraseid ressursse:

  • //try.github.io/
  • //git-scm.com/book/en/v2
  • //www.git-tower.com/learn/
  • //learngitbranching.js.org/
  • //github.com/commitizen/cz-cli