좋은 commit 메세지 작성법

여러 번 보고 숙지를 꼭 해야 할 것 같다.

이걸 잘 알아둬야 프로젝트 버전관리와 협업을 쉽게 할 수 있다.

 

Commit Message 구조

 

type : title

body (본문, 생략 가능)

Resolves : #issueNo, ... (해결한 이슈, 생략 가능)

See also : #issueNo, ... (참고 이슈, 생략 가능)

 

기본 규칙

- 제목과 본문을 빈 행으로 구분

- 첫 글자는 대문자로 작성

- 제목 끝에 마침표X

- 제목은 명령문으로 사용, 과거형X

- 어떻게 보다는 무엇과 왜

 

Type

type keyword                 사용 시점

feat                              새로운 기능 추가

fix                                 버그 수정

docs                             문서 수정

style                             코드 스타일 변경

design                          사용자 ui 디자인 변경

test                               테스트 코드, 리팩토링 테스트 코드 추가

refactor                         코드 리팩토링

build                              빌드 파일 수정

ci                                   ci 설정 파일 수정

perf                                성능 개선

chore                            빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)

rename                          파일 혹은 폴더명을 수정만 한 경우

remove                         파일을 삭제만 한 경우

 

타입 뒤에 변경된 함수나 메소드를 직접 명시하기도 한다.