Jak podpisywać commity, opisywać ogólnie czy dokładnie komentować? Rozumiem, że z każdą zmianą mam wykonywać commit? W firmach opisuje sie commity po Polsku? Czy jest to niespotykane?
0
0
Jak chcesz, możesz tam nawet wpisać wiersz.
0
Jak się połapiesz potem w commitach typu "zrobione", "poprawka", "refactor", albo "lskdjflsd" to twoja sprawa.
Pracując w firmie natomiast trzeba bardziej się postarać, bo czytają to często inni ludzie. Co do języka to różnie, ale przeważnie po angielsku.
0
Co robię ja:
W tytule commitu staram się numerować commity jako wersje (np. 0.3.6_113 oznacza commit 113 po wersji 0.3.6). Korzystam z GitHuba, gdzie można korzystać z listy błędów, propozycji itd., gdzie każda ma swój numer. W takim wypadku, gdy np. naprawiam błąd numer 5 w wersji 0.3.6_113, wtedy w tytule piszę "Wersja 0.3.6_113 - closes #5". GitHub wykrywa wtedy takie słowo kluczowe (może też być "closed", "fixed" itd.) i automatycznie "zamyka" błąd jako naprawiony.
Opisy piszę możliwie jak najdokładniej, opisując jednak same zasady działania, zaś sprawy techniczne ograniczam do minimum (więc np. nie piszę "zmieniłem w pliku X w linijce 10 literę A na B"), bo i tak można to odczytać z listy zmian commitu.
1
Tak:
[US 15] [T 123] - search on customers view finished
reviewed by: Jan Kowalski
Lub tak:
[BUG 13] - fixed search on customers view: missing name parameter added
reviewed by: Jan Kowalski
0
Od razu review? To jak, najpierw robisz patcha, a potem ktoś przegląda i commituje?