Commit Message 규칙
- 제목과 본문을 빈 행으로 구분한다
- 제목을 50글자 내로 제한
- 제목 첫 글자는 대문자로 작성
- 제목 끝에 마침표 넣지 않기
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
- 본문의 각 행은 72글자 내로 제한
- 어떻게 보다는 무엇과 왜를 설명한다
Commit Message 구조
<type> : <subject>
<body>
<footer>Type
FEAT: 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정FIX: 기능에 대한 버그 수정BUILD: 빌드 관련 수정CHORE: 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignoreCI: CI 관련 설정 수정DOCS: 문서(주석) 수정STYLE: 코드 스타일, 포맷팅에 대한 수정REFACTOR: 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경TEST: 테스트 코드 추가/수정RELEASE: 버전 릴리즈
Subject
앞서 언급한 Commit Message 규칙을 준수한다.
예를 들어 회원기능을 수정했다고 한다면 다음과 같이 표시할 수 있다.
FIX : Edit signup api
fix the error that data is not reflected in the database
- ...
- ...
Closes #4Body
헤더로 표현이 가능하다면 생략가능하지만 자세한 내용을 적는다. 이때 어떻게보다는 무엇을, 왜를 위주로 적는다.
Footer
footer는 생략 가능하다. 주로 이슈와 관련이 있다. 커밋과 관련된 이슈 트래킹 번호를 적는다.
Labels
Resolves: 문의나, 요청에 의한 이슈에 해당하는 경우
Closes: 일반적인 개발과 관련된 이슈에 해당하는 경우
Fixes: 버그 픽스, 핫 픽스 관련 이슈에 해당하는 경우
See also: 커밋의 이슈와 연관되어 있는 이슈들이 존재 하는 경우, 또는 관련된 이슈들이 있는 경우
멋져요!🥰