[깃] 깃 커밋 메시지 컨벤션 (깃 메세지 작성법)

커밋 메세지 구조 (commit message structure)

커밋유형: 제목

body

Footer

 

커밋 유형의 종류

1. feat: 새로운 기능 추가
2. fix: 버그 수정
3. docs: 문서 수정
4. style: 스타일 관련 코드 (코드 포맷팅, 세미콜론 누락, production의 변화가 없는 경우)
5. refactor: 코드 리펙토링 (잘돌아가는 코드를 더 좋은 코드로 만드는 작업 (enhancement) )
6. test: 테스트코드

커밋 메세지는 영어로 작성한다

문장은 명령어로 작성한다 (과거형 복수형을 사용하지 않는다)

 

커밋 메세지 구조

1. 제목 (필수)

• 커밋유형: 뒤에 한칸 띄우고 제목을 적어준다
• 제목은 대문자로 시작한다
• 제목에 마침표를 붙이지 않는다
• 50글자 이내로 작성한다
• 어떻게가 아닌 무엇과 왜를 설명한다(대상과 그 이유)
• Issue Tracker 번호를 적어준다

예시

• feat: improve performance with lazy load implementation for images
• chore: update npm dependency to latest version

2. body (선택사항)

• 제목과 body 사이에 한줄을 띄워준다
• 모든 문단은 대문자로 시작해야 한다
• 72글자 이내로 작성한다
• 제목이 충분한 설명이 되었다면 생략할 수 있다

3. Footer

• Issue Tracker 번호는 제목 또는 Footer에 적어줄 수 있다
• 예시) Resolves: #123