[Git] 커밋 메시지 컨벤션

 

 

대다수의 개발자들이 커밋 메시지에 공을 들여 작성하고 있습니다.

왜 커밋 메시지를 잘 쓰기 위해 노력해야 할까요?

여러가지 이유들이 있겠지만 그 중 두가지만 보자면

• 보다 더 나은 협업과 리뷰 프로세스
• 보다 더 나은 코드 유지보수

이러한 이유들 때문에 커밋메시지의 중요성이 강조되는거 같습니다.

 

 

 

 

 

커밋 메시지를 작성하는데에 있어서 지켜야하는 7가지의 규칙이 있습니다.

좋은 커밋 메시지를 남기기 위한 7가지 규칙

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

 

 

 

 

 

type: Subject

body

footer

[커밋메시지 구조]

 

 

 

 

type

feat: 새로운 기능 추가
fix: 버그 수정
docs: 문서 수정
style: 공백, 세미콜론 등 스타일 수정(코드 변경은 없음)
refator: 코드 리팩토링
perf: 성능 개선
test: 테스트 코드 추가 또는 테스트 코드 리팩토링
chore: 빌드 과정 업데이트, 보조 기능(문서 생성기능 등) 수정

 

 

 

커밋 메시지에 부가설명이 많다면 type: subject를 작성 후 한 줄 비우고 body에 상세내용을 적어줍니다.

footer가 필요하다면 한 줄 비우고 적어주면 됩니다.
footer는 중요한 변경지점이 있을 경우 혹은 특정 이슈에 대한 해결 커밋일 경우 해당 이슈의 번호를 적어주는 경우가 있습니다.

feat: 버튼 기능 추가

버튼 누를 시 결제 기능 화면으로 넘어가게 함

Closes #123

[설명이 많을 경우 커밋 메시지 예시]