[Git] Commit 메시지

 커밋 메시지는 협업에 있어 매우 중요하다. 커밋 메시지가 명확할 수록 어떤 변화가 생겼는지 명확하게 알 수 있으며 롤백(rollback)하기도 쉽기 때문이다. 이에 따라 좋은 커밋 메시지를 작성하기 위한 컨벤션을 소개한다. 메시지 구조는 아래와 같다. 커밋 메시지는 commit 명령어에 -m 옵션을 주어 작성할 수 있다. 

 

타입[범위]: 제목 [본문] [꼬릿말]

타입 : 커밋 타입은 아래와 같다. 범위에는 관련된 기능을 적을 수도 있고, 이슈 ID를 적을 수도 있다.

• Feat: 새로운 기능의 추가
• Fix: 버그 수정
• Docs: 문서 수정
• Style: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
• Refactor: 코드 리펙토링
• Chore: 빌드 업무 수정, 패키지 매니저 수정 등 잡다한 일(ex .gitignore 수정 같은 경우)

예시1

제목 : 명령문을 사용하며 50자 이내로 제한한다. 끝에 마침표를 적지 않도록 주의한다.

 

본문 : 구현 방법보다는 변경한 내용과 이유를 설명한다. 한 줄 당 72자 내로 작성하며 양에 구애받지 않고 최대한 상세히 작성한다.

 

꼬릿말 : 선택사항으로 보통 Github Issue 추적을 위해 사용한다. “유형:  #이슈 번호” 형식을 사용하며, 여러 개의 이슈 번호를 적을 때는 쉼표로 구분한다. 유형은 Resolves, See also를 사용한다.