Jak dobrze opisywać commity w gicie?
Cześć. Dzisiaj podpowiem Ci, w jaki sposób opisywać commity w gicie. Zapraszam!
Nie wiesz, czym jest GIT? Zapraszam Cię do przeczytania mojego poprzedniego wpisu: GIT: dla początkujących.
Z czego powinien składać się dobry commit?
- Zaczynaj opis wielką literą i nie kończ go kropką (ani innym znakiem interpunkcyjnym)
- Opisz dokładnie co i dlaczego zostało zrobione. Commit typu „fixed errors” nie do końca mówi co i dlaczego zostało zrobione.
- Staraj pisać się commit podobnie do poprzednich
- Utrzymuj jeden czas, czyli jeżeli piszesz od początku „dodano funkcję X” to nie pisz potem „dodano funkcję Y”. Staraj się trzymać jeden czas i dzięki temu w prostszy sposób będziesz w stanie analizować commity.
- Nie opisuj commita jednym wyrazem na przykład „refactor”, ponieważ nic to nikomu nie mówi
- Pisz w trybie rozkazującym
- Pierwsza linijka nie powinna przekraczać 50 znaków
- Druga linijka zawsze powinna być pusta
Podsumowanie
Mam nadzieję, że wpis Ci pomoże w pisaniu lepszych commitów. Zachęcam Cię do polubienia mojej strony na facebooku/twitterze. Dzięki temu będziesz na bieżąco z moimi nowymi wpisami, które pomogą Ci w przyszłości.