[GIT]How to write good git message

How to write good git message

Good commit messages serve at least three important purposes:

- To speed up the reviewing process.(리뷰를 빠르게 할수 있음)

- To help us write a good release note.(좋은 릴리즈 노트 작성에 도움)

- To help the future maintainers of Erlang/OTP (it could be you!), say five years into the future, to find out why a particular change was made to the code or why a specific feature was added.

(유지보수에 도움이 될수 있음 - ex) 특정 코드가 추가 되었을 때)

Do

- Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".

(명령조 - 동사로 시작되며 현재형을 사용한다 - 의 커밋 로그를 사용하는게 영어로 로그를 작성할때 일반적. 한글로 작성 할 수도 있음.  오픈 소스로 사용할때는 영어를 사용하는 것이 일반적)

- Always leave the second line blank.

(제목과 본문 사이(두번째 행)는 비워 둔다.)

-  Line break the commit message (to make the commit message readable without having to scroll horizontally in gitk).

Don't

- Don't end the summary line with a period 

- it's a title and titles don't end with a period.

Tip

- If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using git add -p.

 

&

ETC.

- git commit -m 은 한줄 커밋을 사용할때 사용하는 것, 개발자에 따라서 사용하지 말라고 하는 사람도 있음 ( git commit 입력 후 vim 에디터로 수정하여 작성하는 것이 정석 )

- commit log에 대한 구체적인 룰은 팀원들과 협의해야 한다.

출처 : https://github.com/erlang/otp/wiki/Writing-good-commit-messages

https://www.slideshare.net/TarinGamberini/commit-messages-goodpractices