Goal
좋은 커밋 메시지를 작성하기 위한 몇가지 규칙들에 대해서 알아본다.
협업과 커밋 메시지
개발자는 혼자 일하는 직업이 아니다. 많은 경우에 다른 사람들과 함께 작업을 하고 그렇기 때문에 협업을 위한 여러가지 규칙이 존재한다.
Git을 통해 코드를 유지하는 경우 커밋과 커밋 메시지에 규칙을 정해 각 커밋에서 어떤 작업이 이루어졌는지 쉽고 명확하게 파악할 수 있다.
그렇다면 좋은 커밋 메시지를 작성하기 위한 규칙에는 어떤것들이 있을까?
좋은 커밋 메시지를 작성하기 위한 규칙들
한 눈에 커밋 메시지를 알아보기 위해 중요한 것 중 하나는 이름을 명시적이고 규칙적으로 작성해주는 것이다.
또한 해당 커밋에 대한 내용을 잘 작성해준다면 코드를 일일히 분석하지 않아도 해당 커밋의 내용을 알아볼 수 있다.
커밋 메시지의 7가지 규칙
1. 제목과 본문을 빈 행으로 구분한다.
2. 제목을 50글자 이내로 제한한다.
3. 제목의 첫 글자는 대문자로 작성한다.
4. 제목의 끝에는 마침표를 넣지 않는다.
5. 제목은 명령문으로 작성하고 과거형을 사용하지 않는다.
6. 본문의 각 행은 72글자 내로 제한한다.
7. 어떻게 보다는 무엇과 왜를 설명한다.
커밋 메시지 구조
$ <type>(<scope>): <subject> -- 헤더
<BLANK LINE> -- 빈 줄
<body> -- 본문
<BLANK LINE> -- 빈 줄
<footer> -- 바닥 글이 중 <type>은 해당 커밋의 성격을 나타내며 아래의 규칙 등이 대표적으로 사용된다.
feat: 새로운 기능의 추가
fix: 버그 수정에 대한 커밋
build: 빌드 관련 파일 수정에 대한 커밋
chore: 자잘한 수정이나 빌드 업데이트
docs: 문서 수정
test: 테스트 코드
refactor: 리팩터링
ci: CI 설정 파일 수정
rename: 파일 혹은 폴더명만 수정한 경우
remove: 파일을 삭제만 한 경우
