커밋 컨벤션

커밋 컨벤션

Git - 커밋 메시지 컨벤션과 커밋 메시지 템플릿을 참고하여 커밋 컨벤션을 정했다.

• 커밋 메시지 구조

type : subject

body

footer

• type 종류

커밋 타입	설명
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 포맷팅 등 코드 변경이 없는 경우
refactor	코드 리팩토링
test	테스트 코드 추가
chore	빌드 업무 수정, 패키지 매니저 수정

• subject

  • 제목은 50자를 넘기지 않고, 한글로 통일한다.
  • 과거시제를 사용하지 않고 명령어로 작성한다.
    • "XX화면에서 버그를 수정했음" -> "XX화면 버그 수정"
    • "테스트 코드 추가했음" -> "테스트 코드 추가"
  • 제목 끝에 마침표(.)를 붙이지 않는다.
  • 제목과 본문은 띄어쓴다.

• body

  • 선택사항이며, 부연설명이 필요할 경우 작성한다.
  • 작성할 때는 "What"보다 "Why"를 적도록 한다.

• footer

  • 선택사항이며, issue tracker id를 작성할 때 사용한다.

• 예시

  feat: issue READ API 구현