Commit Message Convention

Git Commit Message를 잘 쓰려고 노력해야 하는 이유

 

1. 좋은 커밋 로그 가독성

2. 나은 협업과 리뷰 프로세스

3. 쉬운 코드 유지보수

 

Commit Message Type

• Feat : 새로운 기능 구현
• Fix : 버그, 오류 해결
• Docs : 문서 수정
• Style : 포맷, 서식 지정, 세미콜론 누락 등 코드 변경이 없는 경우 (동작에 영향 x)
• Refactor : 코드 리팩토링
• Test : 테스트 코드 추가 및 수정
• Docs : 문서를 수정한 경우, 파일 삭제, 파일명 수정 등 (README 등)
• Hotfix : Issue나 QA에서 급한 버그 수정에 사용
• Add  : 파일 추가
• Chore : 빌드 업무 수정, 패키지 매니저 설정 (내부 파일 수정)

ex)  [Feat] - 로그인 기능 구현, [Docs] - README 수정

 

추가 TIP

긴급 수정이 필요한 경우 type 앞에 !를 붙인다.

ex) [Feat!] 메시지내용

 

Github Issue와 연결 시키고 싶은 경우 Issue Number를 추가해준다.

ex) [Feat] #13(Issue Number) - 메시지내용

 

Github Issue를 Commit을 통해 자동으로 Close

아래의 종료 키워드와 Issue Number를 추가해주면 자동으로 Issue가 삭제된다.

ex) [Fix] #13 - fix error

• close
• closes
• closed
• fix
• fixes
• fixed
• resolve
• resolves
• resolved

---

<참고 문서>

https://meetup.toast.com/posts/106

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속 : NHN Cloud Meetup

https://www.conventionalcommits.org/en/v1.0.0/

Conventional Commits