[깃허브] 커밋 메세지 컨벤션

안녕하세요 aim_higher 입니다.

최근 사이드 프로젝트를 진행하고 있는데요,

제가 컨벤션을 지키며 커밋 메세지를 작성하는지 되짚어 보았습니다.
모호하게 아는 것보단 그냥 외우는게 나을 듯해 작성해보았습니다.

---

Commit 메세지는 type(제목), body(본문), footer(꼬리말)로 구성

type(태그 / 제목)
많이 쓰는 순서로 정리해봤습니다

• Feat: 새로운 기능 추가
• Fix: 버그 수정
• Design : CSS 등 사용자 UI 디자인 변경
• Refactor: 코드 리팩토링
• Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업인 경우
• Docs: 문서 수정
• Style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• !HOTFIX : 급하게 치명적인 버그를 고친 경우
• !BREAKING CHANGE : 큰 API 변경이 있을 경우
  
  
• Test: 테스트 코드, 리팩토링 테스트 코드 추가
• Chore: 빌드 업무 수정, 패키지 매니저 수정

body(how보다는 what, why)

• 양에 구애받지 않고 최대한 상세히 작성

footer(유형: #이슈번호)
이슈트래커 유형

• Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
• Resolves: 이슈를 해결했을 때 사용
• Ref: 참고할 이슈가 있을 때 사용
• Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

commit 예시

Feat: 회원 가입 기능 구현

SMS, 이메일 중복확인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45