1. Dom
  2. Pytanie i odpowiedź
  3. Standard, który należy przestrzegać podczas pisania wiadomości zatwierdzania git.

Standard, który należy przestrzegać podczas pisania wiadomości zatwierdzania git.

2013-03-10 9 views
65

Zarządzam bardzo wieloma plikami (ponad 60, ale poniżej 70), a moje komunikaty o zatwierdzeniu do tej pory są zgodne z następującym wzorcem: Po dodaniu czegoś podobnego na layout.css, mój komunikat zatwierdzenia to "dodano coś na pliku layout.css", a po usunięciu czegoś mój komunikat zatwierdzenia to "usunięto coś z pliku layout.css".Standard, który należy przestrzegać podczas pisania wiadomości zatwierdzania git.

Niektóre pliki wzdłuż linii, patrzę na mojego zmian są dodatkiem paszowym i ... i ... usunięte wiadomości dominować. Czasami nie pamiętam, co usunąłem lub co dodałem w layout.css, ponieważ robię tak wiele zmian za jednym razem, dlatego mam problem z wysłaniem odpowiedniego komunikatu zatwierdzenia.

Czy istnieje standard, który powinienem zastosować, aby pomóc mi wymyślić moje komunikaty o zatwierdzeniu?

Źródło

2013-03-10 Gandalf

+2

http://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatowanie – vijay

+4

To pytanie nie jest duplikatem połączonego pliku. To pytanie dotyczy treści wiadomości zatwierdzania, podczas gdy powiązane pytanie dotyczy konkretnej praktyki formatowania. – Ajedi32

+0

Hei Gandalf, gdzie byłeś? Oto ja, twój zagubiony koń. Proszę, nie opuszczaj mnie ponownie! :-) –

Odpowiedz

66

Po prostu opisać, co zrobiłeś (w technicznych jeszcze rozmytych pojęć, jak "dodano funkcję"), nie dodajesz zbyt wiele do tego, co Git już przechowuje w zatwierdzeniu. Wyobraź sobie, że czytasz komunikat zatwierdzenia jakiś czas później; jakiego rodzaju podsumowanie pomogłoby Ci w zapamiętaniu/komunikowaniu innym programistom istoty tej zmiany ?! Dokładne treści zależą od projektu i procesów, ale uważam, że jest to dobra wskazówka.

Dlatego przede wszystkim dodać kontekst (the dlaczego, nie jak) z popełnienia wiadomości (na przykład "frobnize wiadomość, aby umożliwić utrzymywanie") zamiast "Dodano FROB() Funkcja"). To więcej wysiłku (musisz się zastanowić i myśleć), ale warto o wiele więcej.

Jeśli chcesz dowiedzieć się więcej na ten temat, znajdziesz tam mnóstwo informacji, na przykład this blog article by Peter Hutterer lub this funny slide.

Źródło

2013-03-10 17:11:22

+4

+1 dla podkreślenia *** dlaczego *** zamiast * jak *. – Gady

+2

Co to jest "frobnize"? – Bernard

+3

@Bernard: To tylko bzdurny czasownik nonsens, jako symbol zastępczy. Pochodzenie w "frob" i "frobnicate" z [pliku Jargona] (http://www.catb.org/jargon/html/F/frob.html). –

8

Git już wie, które pliki zmodyfikowałeś w commit, bezużyteczne jest określenie go w komentarzu. Po prostu powiedz na przykład "naprawiony błąd padding" lub "dodane menu na pasku bocznym". Wyjaśnij, to wszystko.

Źródło

2013-03-10 17:02:15 mimipc

39

Model 50/72 wydaje się być dobrą praktyką. tj. ... pierwsza linia powinna mieć 50 znaków i powinna być serwerem jako nagłówek. Po spacji, drugi zestaw linii powinien być zawinięty na 72 znaki i powinien służyć jako podsumowanie. Oto pytanie: Git Commit Messages : 50/72 Formatting, które omawia to samo.

Oto kilka wyczerpujące notatki na temat:

  1. GIT Commit Good Practice
  2. A Note About Git Commit Messages
  3. Proper Git Commit Messages and an Elegant Git History

Źródło

2013-03-10 17:03:13 vijay

Powiązane problemy

 Powiązane problemy