Git Commit message 규칙

verdantgreeny·2025년 2월 11일

본캠프

목록 보기
38/56

첫 개인프로젝트였던 영화 검색 사이트 때 튜터님의 피드백으로 Commit message 규칙을 지키는 것이 좋다고 하셨고 나름대로 규칙을 따르려고 했으나 찾아보는 곳마다 다양한 규칙이 있었다.

어느 곳에서는 "style: css 변경" 이었다가 다른 곳을 보니 "style: 코드 포맷팅, 세미클론 누락, 코드 변경이 없는 경우"라고 하는 곳이 있어 그 기준점을 잡기가 쉽지 않았다.

지금까지는 혼자하는 프로젝트였지만 앞으로 진행될 협업 프로젝트에 앞서 협업하는 팀원분들에게 도움이 되고 싶어 알아보게 되었다.

* 메시지 구조: 커밋 메세지는 크게 제목, 본문, 꼬리말로 나뉜다고 한다. 여기서 나는 제목 부분을 어떻게 작성해야 하는지를 알아보도록 하겠다.

1.타입 (태그: 제목)

1-1. 기능

  • Feat: 새로운 기능을 추가할 경우
  • Fix: 버그를 고친 경우
  • Design: CSS 등 사용자 UI 디자인 변경
  • !BREAKING CHANGE: 커다란 API 변경의 경우
  • !HOTFIX: 급하게 치명적인 버그를 고쳐야하는 경우

1-2. 개선

  • Style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
  • Refactor: 프로덕션 코드 리팩토링
  • Comment: 필요한 주석 추가 및 변경

1-3. 그 외

  • Docs: 문서를 수정한 경우(ex. README.md 수정)
  • Test: 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
  • Chore: 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
  • Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
  • Remove: 파일을 삭제하는 작업만 수행한 경우

2. 제목적는 요령

제목은 코드 변경 사항에 대한 짧은 요약을 나타낸다. 제목은 다음의 규칙을 지킨다.

  1. 제목의 처음은 동사 원형으로 시작합니다.
  2. 총 글자 수는 50자 이내로 작성합니다.
  3. 마지막에 특수문자는 삽입하지 않습니다.
    예) 마침표(.), 느낌표(!), 물음표(?)4. 제목은 개조식 구문으로 작성합니다.

만약 영어로 작성하는 경우 다음의 규칙을 따른다. 

  1. 첫 글자는 대문자로 작성합니다.
  2. "Fix", "Add", "Change"의 명령어로 시작합니다.

한글로 제목을 작성하는 경우 다음의 규칙을 따른다.

  1. "고침", "추가", "변경"의 명령어로 시작합니다.

출처: 협업을 위한 기본적인 git 커밋컨벤션 설정하기

0개의 댓글