Git - 커밋컨벤션(commit convention)이란?

Git은 협업도구이지만 주로 프로젝트를 혼자하다보니 협업에 어울리게 제대로 사용하지 못하고 있다는걸 알게되었다.

열심히 commit을 해주고 있었지만, 스스로가 나중에 찾아보더라도 각각 올려진 메시지의 내용을 파악하기 힘들다는 문제점도 자각하게 되고 해당 방식을 고치고자 찾아보니 커밋컨벤션이라는 방식이 있었다.

 

메시지의 구조

제목(title)
\n(개행)
본문(body) > 생략가능
\n(개행)
꼬리말(footer) > 생략가능

위의 형태의 구조로 사용한다.

 

 

커밋의 종류

Type	Description	Example
chore	기타 작업	chore: 빌드시 자동 설정 옵션 추가
design	css 관련 UI 디자인 작업	design: 회원가입 양식 디자인 추가
docs	주석 작업, 문서 추가 관련	docs: 검증 api 관련 docs추가
feat	새로운 기능을 추가	feat: 회원 가입 기능 추가
fix	버그 수정	fix: 비밀번호 유효성 검사 오류 수정
refactor	프로덕트 리팩토링	refactor: userJoin 메소드를 유효성부분과 분기처리
remove	디렉토리, 파일을 삭제하는 경우	remove: 유효성 test모듈 삭제
rename	디렉토리, 파일명만 수정, 경로 변경 등	rename: Join디렉토리에 관련 소스 정리
test	테스트 관련 작업	test: 회원가입 테스트 추가

 

 

작성 규칙

타입 종류들과 성격을 파악했으니 사용법을 알아보겠습니다.

• 제목은 50자 이내로 작성
• 본문은 한 줄당 72자 이내로 작성
• 제목과 본문 사이는 개행 한줄을 넣어서 분리
• 문장에 끝에 마침표(.)를 사용하지 않음
• 문장은 명사로 끝냄

 

 

작성 팁

제목

• 간결하고 요약하여 작성한다.
• 마침표나 특수기호는 사용하지 않는다.
• 과거시제를 사용하지 않는다.

 

본문

• 최대한 상세하게 작성한다.
• 본문 작성시 변경 내용에 대한 것보단 왜 변경되었는지, 무엇을 바꾸었는지 초첨을 둔다.

 

 

Github 적용 예시

처음 적용하다보니 개행 실수가 있어서 git commit --amend로 내용을 수정해주었다.

상세 내용을 펼치기전에는 제목만 보이며 상세 내용을 펼치면 body부분이 보인다.

(캡처에도 개행하나가 제대로 안들어가있네요... 적응하도록 노력해야겠습니다.)