[git] 커밋 메세지 가이드라인

커밋 메세지 가이드라인

짧은(72자 이하) 요약:

자세한 설명을 위한 본문입니다. 요약과 본문 사이의 공백 라인은 중요합니다 (본문이 없는 경우 제외).

"버그 수정"과 같이 적어주십시오. 이러한 규칙은 git merge 및 git revert와 같은 명령어에서 생성되는 커밋 메시지와 일치합니다.

빈 줄 이후 추가 단락을 작성할 수 있습니다.

글머리 기호도 괜찮습니다.
일반적으로 하이픈 또는 별표가 사용되며, 그 뒤에 공백이 한 칸 있습니다. 들여쓰기를 사용하세요.

좋은 git 커밋 메시지 작성 규칙:

• 본문과 제목은 공백 한 줄로 구분합니다.
• 제목 끝에 마침표를 찍지 마세요.
• 제목과 각 단락은 대문자로 시작합니다.
• 제목에는 명령어의 형태를 사용하세요.
• 줄을 72자로 줄여 적어주세요.
• 변경 사항의 "어떤" 부분에 대해서 설명하는 것이 바람직합니다. "어떻게"에 대한 세부 정보는 생략할 수 있습니다.

커밋 메시지에서 전달하는 정보

• 변경 사항의 이유를 설명하세요.
• 이 변경 사항이 어떻게 문제를 해결하는지 설명하세요.
• 변경 사항이 어떤 효과를 가지는지 설명하세요.
• 리뷰어가 원래 문제를 이해하는 것을 가정하지 마세요.
• 코드가 자명한 것이 아니라면 코드에 대해 설명하세요.
• 커밋 메시지에서 코드 구조가 개선되었는지 암시하는지 확인하세요.
• 첫 번째 커밋 라인이 가장 중요합니다.
• 현재 코드의 한계를 설명하세요.
• 패치 세트별로 특정한 코멘트는 포함하지 마세요.

커밋 메시지 참고사항

커밋이 이슈와 관련이 있다면, 커밋 메시지 헤더나 본문에 이 정보를 추가하세요. 예를 들어, GitHub 웹 플랫폼은 이슈 ID (예: #123)를 관련된 이슈를 참조하는 링크로 자동 변환합니다. Jira와 같은 이슈 트래커에서는 Jirafy와 같은 플러그인을 사용하여 Jira 티켓도 변환할 수 있습니다.

출처: https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md