Commit message rules (커밋 메세지 규칙) #4
Description
Commit message
Separate subject from body with a blank line.
Limit the subject line to 50 characters.
Capitalize the subject line.
Do not end the subject line with a period.
Use the imperative mood in the subject line.
Wrap the body at 72 characters.
Use the body to explain what and 'why' vs. 'how'. ('How' is explained in the code.)
If you are using Issue Tracker, add a reference at the bottom of the content.
Example )
Derezz the master control program
MCP turned out to be evil and had become intent on world domination.
This commit throws Tron's disc into MCP (causing its deresolution)
and turns it back into a chess game.
Resolves : #123
See also : #456, #789
커밋 메세지
제목과 본문을 빈 행으로 분리한다.
제목 행을 50자로 제한한다.
제목 행 첫 글자는 대문자로 쓴다.
제목 행 끝에 마침표를 넣지 않는다.
제목 행에 명령문을 사용한다.
본문을 72자 단위로 개행한다.
'어떻게'보다는 '무엇'과 '왜'를 설명한다. ('어떻게'는 코드가 설명한다.)
이슈 트래커를 사용한다면 내용 하단에 참조를 추가한다.
예시)
마스터 컨트롤 프로그램 삭제
마스터 컨트롤 프로그램(MCP)이 사악하게 변해서 세계를 통제하려고 함.
이 커밋은 Tron 디스크를 MCP에 (삭제를 위해) 던져 넣어 MCP는 다시 체스
게임으로 돌아감.
해결 : #123
참고 : #456, #789