[Git] Commit 메시지 가이드라인

💡 본 문서는 'Git Commit 메시지 가이드라인'에 대해 정리해놓은 글입니다.
Git Commit 샘플을 포함하여 가이드라인을 제시해놓았으며, 반드시 따르지 않아도 무방하니 참고하시기 바랍니다.

샘플 커밋 메시지 예시(예시는 한글로 작성되었으나 커밋은 가급적 영어로 작성하시오):

72자 이내의 짧은 요약

더 상세한 설명을 적는다. 72자 이내의 짧은 요약을 첫 줄에 적은 뒤 
빈 줄을 하나 삽입하고, 그 다음에 상세한 설명을 적도록 한다.
요약만으로 충분한 경우 상세한 설명은 적지 않아도 좋다.

커밋 메시지는 명령형으로 적도록 한다: Fix bug 라고 적으라. 
Fixed bug, Fixes bug 등은 사용하지 않도록 한다.
이는 커밋 메시지가 git merge 혹은 git revert 등으로 생성되는 커밋 메시지와
컨벤션이 일치하도록 하기 위함이다.

단락 구분은 빈 줄을 삽입하여 할 수 있다.

- 이렇게 리스트를 표기하여도 좋다
- 리스트는 하이픈(-) 혹은 별표(*)를 통해 작성하라

좋은 커밋 메시지는 다음 문장에 들어갔을 때 문법적으로 맞아야 한다:

If applied, this commit will <your subject line here>

좋은 커밋 메시지를 작성하기 위한 규칙

• Separate subject from body with a blank line
• Do not end the subject line with a period
• Capitalize the subject line and each paragraph
• Use the imperative mood in the subject line
• Wrap lines at 72 characters
• Use the body to explain what and why you have done something. In most cases, you can leave out details about how a change has been made.

커밋 메시지가 포함해야 하는 정보

• Describe why a change is being made.
• How does it address the issue?
• What effects does the patch have?
• Do not assume the reviewer understands what the original problem was.
• Do not assume the code is self-evident/self-documenting.
• Read the commit message to see if it hints at improved code structure.
• The first commit line is the most important.
• Describe any limitations of the current code.
• Do not include patch set-specific comments.

더 많은 정보와 예시는 다음 링크를 참조하시오: GitCommitMessages - OpenStack

커밋 메시지에 링크, 레퍼런스를 넣는 법

커밋이 링크나 이슈를 포함해야 한다면, 커밋 메시지의 헤더나 본문에 삽입할 수 있다. 지라 등을 사용하는 경우 Jirafy 와 같은 도구를 사용하여 짧은 번호를 이슈에 매칭시킬 수 있다.

헤더 예시:

[#123] 깃헙은 #123만으로 이슈에 매칭이 된다…

CAT-123 같은 방식은 Jira 이슈 매칭용으로 사용하기 좋다…

본문 예시:

…
Fixes #123, #124

+ 병합(merge) 정책

main 브랜치의 직접 수정은 금지하며, 각 브랜치는 풀 리퀘스트(pull request) 생성 후 병합합니다.

개별 개발자는 풀 리퀘스트 후 코드리뷰를 요청할 수 있으며, 코드리뷰가 필요없는 경우 직접 병합할 수 있습니다. 그리고 병합된 브랜치는 삭제(delete)하는 것을 원칙으로 합니다.

추가로, 병합 후 문제를 방지하고자 merge시 각 브렌치에 main을 머지한 후 문제가 없는 것을 확인 후 이를 다시 main에 머지하는 작업을 진행하면 좋습니다.

참고

• [Blog] tbaggery - A Note About Git Commit Messages: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
• [Blog] GitCommitMessages - OpenStack: https://wiki.openstack.org/wiki/GitCommitMessages
• [Blog] How to Write a Git Commit Message: http://chris.beams.io/posts/git-commit/