Hogyan lehet félelmetesvé tenni az elkötelezettséggel járó üzeneteket, és boldoggá tenni a csapatát

A vállalási üzenetek fontos kommunikációs eszközök a csapattagok között

A csapatszoftver-fejlesztésben a legfontosabb a kommunikáció. A kötelezettségvállalási üzenetek fontos kommunikációs eszközök a csapat tagjai között: múltja és jövője.

A kód elemzése vagy a hibakeresés során mindannyiunknak vannak olyan kérdései, mint:

  • Miért van ez , ha itt?
  • Ki felejtette el frissíteni a fiókot?
  • Milyen hatása volt ennek a változásnak?
  • Hogyan javíthatja vagy javíthatja ez a változás valaha a kódot?

Ebből a célból a git-blame lehetővé teszi számunkra, hogy kiderítsük, melyik változat változtatta meg utoljára a fájlt. De ennek ismerete nem elég jó. Hasznos lenne elolvasni az elkötelezettség üzenetét, hogy megértsük, mi történt ott.

El kell olvasnunk az üzenetet, hogy megtapasztaljuk a jó elkötelezettség üzenetének valódi értékét, és motiváltnak kell lennünk azok megírására.

Néhány bevált gyakorlat

Tehát, ha az eddigi Git-kötelezettségvállalásainak többségét valami hasonlóval hozták létre, git commit -m "9000 — Bug fixes issue"akkor legközelebb próbálja ki ezt az irányelvet:

Soha ne használja az o git elkötelezettséget.-m sg> / --message=gt; flag t

Ez rossz gondolkodásmódot ad rögtön, mivel úgy fogja érezni, hogy be kell illesztenie a végrehajtási üzenetet a terminál parancsba, és az elkötelezettséget inkább egyszeri érvnek érzi, mint a történelem egyik oldalát.

Az első sornak mindig legfeljebb 50 karakterből kell állnia, és egy üres sort kell követnie.

Írjon imperatív időt: „Fix bug”. [ Add | Javítás | Távolítsa el a | Frissítés | Refactor ] A következetes megfogalmazás megkönnyíti a tettek listájának mentális feldolgozását.

72 karakterből álló hosszabb leírás.

Gyakran egy téma önmagában is elegendő.Ha nem, akkor vegyen fel egy üres sort (ez fontos), amelyet egy vagy több bekezdés követ, keményen, 72 karakterre csomagolva.

Ezeknek a bekezdéseknek meg kell magyarázniuk:

Miért szükséges ez a változás?

Ez a válasz elmagyarázza, hogy mi várható az elkötelezettségben, lehetővé téve számukra, hogy könnyebben azonosítsák és rámutassanak a nem kapcsolódó változásokra.

Hogyan kezeli a kérdést?

Írja le magas szinten, hogy mit tettek a változás befolyásolására. Ha a változás nyilvánvaló, akkor elhagyhatja a kérdés megválaszolását.

Milyen mellékhatásai vannak ennek a változásnak?

Ez a legfontosabb megválaszolandó kérdés, mivel rámutathat azokra a problémákra, amelyeken túl sok változtatást hajt végre egy elkötelezettségben vagy ágban. Lehetséges, hogy a kapcsolódó változások egy vagy két pontja rendben van, de öt vagy hat valószínűleg a túl sok mindent elkövető elkötelezettség mutatói.

# 50-character subject line## 72-character wrapped longer description. This should answer:## * Why was this change necessary?# * How does it address the problem?# * Are there any side effects?## Include a link to the ticket, if any.

Hogyan lehet megkönnyíteni az életét

Sokat kell emlékezni rá, de a. Használatával beállíthat egy elkötelezett üzenet sablont commit.template

Állítsa be a Git-et egy sablonfájl (például .gitmessage) használatára, majd hozza létre a sablonfájlt a Vim használatával:

git config --global commit.template ~/.gitmessagevim ~/.gitmessage

Ha git commitaz -müzenetjelző nélkül futunk , a szerkesztő készen áll a megnyitásra:

# [Add/Fix/Remove/Update/Refactor/Document] [summary]# Why is it necessary? (Bug fix, feature, improvements?)-# How does the change address the issue? -# What side effects does this change have?-# Include a link to the ticket, if any.

A megjegyzéseket tartalmazó sorok nem szerepelnek a végső üzenetben. Egyszerűen töltse ki az üres sorokat szöveggel és pontokkal az utasítások alatt.

Issue követők GitHub és Bitbucket egyaránt elismerik a kulcsszavakat close, fixés resolverögtön követ a kérdés, vagy húzza kérelem száma.

Szerintem Linus nagyon örülne, ha git commit -m "Fix bug"soha többé nem használnánk egy nyilvános adattárban :)

A git naplóban egyszerűen megkereshet egy számot, például a git log --grep=JIRA-1234

Használhat olyan beépülő modulokat is, mint például vim-fugitivea vim vagy git lensa vs kód, hogy gyorsan elérhesse a git elkötelezettségű üzeneteket.

Záró gondolatok

A tiszta Git elkötelezettségek létrehozása sokat elárul rólad, és ez lehet az elsődleges módja annak, hogy az emberek kapcsolatba lépjenek veled projektek során.

Egy kis gyakorlással elkötelezettségének szokásait még jobban tükrözi legjobb munkája - ez a munka nyilvánvalóan gondos és büszke.

A jövőd, te és a csapatod meg fog köszönni előrelátásodért és bőbeszédűségedért, amikor futnak, git blamehogy megnézzék, miért van ez a feltétel.

Ha tetszett ez a cikk, kérjük, tapsoljon, ajánljon és ossza meg.