Skip to content

Commit Convention

민규 edited this page Sep 8, 2023 · 8 revisions

Commit message 구조 💻

타입 : 내용(#issueNumber)

Commit message Type

  • fix : 버그 및 에러 수정에 관한 커밋 메시지
  • add : 파일 추가에 관한 커밋 메시지
  • delete : 파일 삭제에 관한 커밋 메시지
  • docs : 문서화에 관련된 커밋 메시지
  • feat : 새로운 기능 추가에 관련된 커밋 메시지
  • modify : 파일, 폴더, 코드 수정 시 커밋 메시지
  • refactor : 코드 고도화에 관련된 커밋 메시지
  • comment : 주석 추가
  • setting : 세팅 관련된 커밋 메시지

Commit message Rule

  • 메세지 타입은 영어로, 내용은 한글로 작성
    ex) modify : ㅇㅇ 기능 코드 수정(#issueNumber)
  • 팀원들이 이해하기 쉽게 직관적으로 작성할 것
  • 커밋 메세지는 3줄 이내로 작성할 것
  • 남겨야할 메세지가 길 경우에는 Git Issue 사용
  • PR 전에 분할된 커밋은 rebase로 합치기

Clone this wiki locally