Git commit – jak dobrze napisać komunikat ?

W trakcie stypendium i programu Nanodegree w specjalności Mobile Web Specialist jeden z modułów kursu dotyczył kontroli systemu wersji Git i komunikatów umieszczanych przy kolejnych wersjach oprogramowania. Zbiór zaleceń trenerów można znaleźć na Udacity Git Style Guide. Poniżej przedstawię kilka z nich, które wykorzystuje na co dzień.

Struktura komunikatu

Każdy z komunikatów zaleca się, by miał 3 elementy:

TYP: TYTUŁ

OPIS

Typy komunikatów

Poniższe typy komunikatów są tylko propozycją, które można zapisywać w postaci zwrotów w języku angielskim:

  • feat: nowa funkcjonalność
  • fix: poprawka błędu 
  • docs: zmiany w dokumentacji
  • style: drobne zmiany w formatowaniu czy komentarzach
  • refactor: refaktoryzacja kodu
  • test: zmiany w testach

Przykład komunikatu

feat: Dodanie możliwości eksportu danych do CSV

W liście wszystkich połączeń dodano dodatkowy przycisk umożliwiający pobranie danych w postaci pliku CSV.

 

 

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Pola, których wypełnienie jest wymagane, są oznaczone symbolem *

Time limit is exhausted. Please reload CAPTCHA.