7 dobrych praktyk pisania komentarzy w git.

  1. Komentarz podziel na tytuł oraz treść komentarza.
    Użyj do tego polecenia git commit ale bez flagi -m
  2. Długość tytułu komentarza max 50 znaków
  3. Rozpoczęcie komentarza dużą literą, oczywiście ze względów estetycznych
  4. Nie dodawaj kropki na końcu komentarza
  5. Używaj trybu rozkazującego w treści tytułu, np: Add email field to login form, zamiast New field in login form. Pamiętaj! – reguła ta dotyczy wyłącznie tytułu!
  6. Ogranicz linię kodu do 72 znaków. Edytory tekstu można zaprogramować w taki sposób, aby po określonej ilości znaków łamały wiersz, np: Sublime Text 3.
  7. Pisząc treść komentarza odpowiadaj na pytanie “- co?” i “- dlaczego?”. Na pytanie – jak? można odpowiedzieć przeglądając wprowadzone zmiany.