커밋 메세지 규칙

커밋 메세지 규칙 개요

• 커밋 메세지만 봐서 코드가 어떻게 변하였는지 쉽게 유추할 수 있도록 작성한다.
• 일관되게 작성하여 가독성 향상 시킨다.

기본 규칙

1. 커밋 메세지는 최대한 한글로 작성하며 영어로 작성할 경우 명확히 전달될 경우에만 영어로 작성한다.
2. 커밋 메세지는 유형별로 분리해서 작성한다.
3. 메세지 제목은 변경 내용을 최대한 간결하게 작성한다.
4. 메세지 본문에는 변경 사항을 상세히 작성한다.

커밋 메세지 구성

• 커밋 메세지는 제목, 본문, 꼬리말로 구성되며 각 영역은 빈 줄로 구분된다.

메세지 제목

메세지 본문

메세지 꼬리말

커밋 메세지 제목 작성

• 제목은 {유형 : 제목}으로 작성한다.
• 예시 : 기능 : 로그인 기능 추가

제목 유형

• 기능 : 기능 추가, 기능 변경, 기능 수정, 기능 삭제 등 실제 기능의 변경이 있을 때 사용한다.
• 리팩토링 : 기능의 변경 없이 코드의 변경이 있을 때 사용한다.
• 스타일 : 기능의 변경이 없고 단순 코드 스타일이나 주석 등을 수정할 때 사용한다.
• 테스트 : 테스트 코드에 대한 수정이 있을 때 사용한다.
• 문서 : 리드미 등 문서를 수정할 때 사용한다.
• 빌드 : 빌드 관련 파일 수정이 있을 때 사용한다.
• 기타 : 그외 수정이 있을 때 사용한다.

커밋 메세지 본문 작성

• 제목으로도 충분하면 생략할 수 있다.
• 코드가 어떻게 변경되었는지보다 무엇을 왜 변경하였는지에 초점을 맞춘다.

꼬리말 작성

• 어떤 이슈와 연관이 있는지 등을 추가할 때 사용한다. #{이슈 번호}
• 필요 시 close #{이슈 번호}를 사용하여 병합시 자동으로 관련 이슈가 close되도록 한다.