커밋 메시지 컨벤션

태그

•

문장은 간결하게 구성한다.

•

문장은 현재형을 사용한다.

•

어떻게 보다는 무엇과 왜를 설명한다.

•

커밋 메시지는 타입: 주제 (#이슈번호)와 같이 작성한다.

◦

예) add: ListView에 누락된 문구 추가 (#5)

•

커밋 메시지는 제 3자가 봤을 때 무엇을 했는지 파악할 수 있게 자세히 작성한다.

•

한 커밋에는 한 가지 기능만 담는다.

◦

예) 화면 개발 : 컴포넌트 단위

◦

예2) 기능 개발 : 기능 단위

•

타입은 해당 커밋의 성격을 나타낸다.

•

타입은 타입의 종류 중 하나만 선택한다.

•

타입은 영어 소문자로 시작한다.

•

타입의 종류

	사용 상황	사용 예시
fix	올바르지 않은 동작(버그)을 고친 경우	fix: 통계 캐시 버그 수정
feat	새로운 기능을 추가한 경우	feat: 카카오 로그인 추가
refactor	내부 로직은 변경하지 않고 코드를 개선한 경우 클래스명 수정, 가독성을 위해 변수명을 변경한 경우도 포함	refactor: 쓰레드 관리 체계 개선 refactor: 유효성 검사 개선 refactor: i 변수 명을 index로 변경. 가독성 목적
style	코드 개선과 상관없이 사소하게 코드를 수정한 경우 줄 바꿈, 누락된 세미콜론 추가 등의 작업도 포함	style: Login 메소드에 빈 줄 추가
design	사용자 UI 디자인을 추가, 수정한 경우 (마크업, 퍼블리싱 작업)	design: desktop 반응형 디자인 적용
add	파일, 폴더 등 추가	add: LoginActivity 추가
move	코드, 파일 등의 위치 이동	move: Member Package의 위치를 Account로 이동
rename	파일명, 폴더명, 이미지명 등 수정	rename: List 컴포넌트명을 ListView로 수정
remove	코드, 파일 등 삭제	remove: 사용하지 않는 파일 삭제 remove: 불필요한 문구 삭제
assets	에셋을 추가, 수정한 경우	assets: 로고 이미지 추가
docs	문서를 추가, 수정한 경우	docs: README.md 내용 추가
chore	위의 모든 경우에 포함되지 않는 기타 변경 사항 빌드 업무 수정, 패키지 매니저 수정 등을 포함	chore: jackson-databind를 2.10.1에서 2.11.4로 업그레이드

주제는 한글로 간단 명료하게 작성한다.

-  올바르지 않은 케이스
refactor: 가독성 향상을 위해서 변수명이 i인 변수를 index로 변경

-  올바른 케이스
refactor: i 변수 명을 index로 변경. 가독성 향상 목적 

주제의 마지막 문자로 .(마침표)를 금지한다.

-  올바르지 않은 케이스
feat: 카카오 로그인 추가.

-  올바른 케이스
feat: 카카오 로그인 추가

주제는 동사 원형으로 끝내지 않고, 현재형을 사용한다.

-  올바르지 않은 케이스
feat: 카카오 로그인 연동 기능을 추가한다
feat: 카카오 로그인 연동 기능을 추가했음

-  올바른 케이스
feat: 카카오 로그인 추가

주제는 소스 코드를 보지 않고도 변경 사항이 무엇을 하는지 알 수 있도록 작성해야 한다.

-  올바르지 않은 케이스
add: ‘use’ 메소드 추가
design: CSS 조정

-  올바른 케이스
add: Credit 모델에 ‘use’ 메소드 추가
design: text box와 layout frame 사이에 left padding 추가

•

케이스 출처 : 커밋 메시지 가이드