Git 커밋 메시지 규칙

팀원과의 소통과 편리한 과거 기록의 추적을 위해 커밋 메시지는 규칙에 맞게 잘 작성하는 것이 좋다.

팀에서 정한 규칙이 따로 있다면 그것을 따르는 것이 좋다.

커밋 메시지의 7가지 규칙

1. 제목과 본문을 빈 행으로 구분한다.
2. 제목은 50글자 이내로 제한한다.
3. 제목의 첫 글자는 대문자로 작성한다.
4. 제목 끝에는 마침표를 넣지 않는다.
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다.
6. 본문의 각 행은 72글자 내로 제한한다.
7. 어떻게 보다는 무엇과 왜를 설명한다.

커멧 메시지의 구조

타입(스코프): 주제(제목) //Header(헤더)

본문 // Body

바닥글 // Footer

• Header
  • 필수이며 타입(스코프)은 생략 가능하다.
  • 타입은 커밋의 성격을 나타낸다.
• Body
  • Header에서 표현할 수 없는 상세한 내용을 적는다.
  • Header에서 충분히 표현할 수 있다면 생략 가능하다.
• Footer
  • 바닥글로 어떤 이슈에서 왔는지 같은 참조 정보들을 추가하는 용도이다.
  • 생략 가능하다.

IntelliJ 기준 예시

cmd 기준 예시

git add file
git commit -m "fix : 어떤 작업 중 오류 수정 // "로 시작, "로 닫지 않고 enter누르면 줄바꿈. 
>>
>> ~~ 작업의 오류 수정 완료 (바디)
>>
>> " // "로 마무리

타입(스코프) 종류

• feat : 새로운 기능에 대한 커밋
• fix : 버그 수정에 대한 커밋
• build : 빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
• chore : 그 외 자잘한 수정에 대한 커밋
• ci : ci 관련 설정 수정에 대한 커밋
• docs : 문서 수정에 대한 커밋
• style : 코드 스타일 혹은 포맷 등에 관한 커밋
• refactor : 코드 리팩토링에 대한 커밋
• test : 테스트 코드 수정에 대한 커밋
• perf : 성능 개선에 대한 커밋