해당 글이 정확한 git commit 작성법은 아니지만 참고용으로 적어보았다.
git을 사용하다가 commit 메세지가 중구난방이 되어서 어떤 방식으로 메세지를 작성해야 하는지 찾아보았다.
Commit Message 작성법
- commit 메세지는 간결하고 명확해야한다.
- 본문이 있을 경우, 제목과 본문은 분리해야한다.
제목은 간결한 설명을 쓰고, 본문은 자세한 정보를 제공하자. - 제목 작성 방법
- 제목은 명령문 형식으로 작성한다.
- 첫 글자는 대문자로 시작하고 마침표를 붙이지 않는다.
- 제목은 현재 시제를 사용한다.
- 가능한 50자 이내로 유지한다.
ex) Fix bug / Add feature
- 본문 작성 방법
- 본문은 제목 아래 작성하며, 변경 내용에 대한 자세한 설명을 포함한다.
- 본문은 72자 이내로 줄을 바꾸어 가독성있게 작성한다.
- 본문에 작성할 내용은 변경이유, 어떤 문제를 해결하는지, 어떤 변경을 했는지 등을 기술한다.
commit message 구조
<타입>(선택사항): <제목>
<본문>
<바닥글>일반적인 타입 규칙은 아래와 같지만, 프로젝트의 요구사항에 따라 사용자 정의 타입을 추가할 수 있다.
| 타입 | 설명 |
|---|---|
| feat | Feature; 새로운 기능이나 기능의 추가 |
| fix | Bug Fix; 버그 수정 |
| docs | Documentation; 문서 업데이트 |
| style | Code Style; 코드 스타일, 포맷팅, 공백 등의 변경 코드의 가독성을 개선하거나 일관된 코딩 스타일을 적용하는 경우 사용 |
| refactor | Code Refactoring; 코드 구조의 개선이나 중복 코드 제거 등을 목적 |
| test | Tests; 테스트 코드 작성 또는 수정 |
| chore | Chores; 일반적인 작업이나 빌드 프로세스 관련 작업 |
| perf | Performance; 코드의 실행 속도나 성능을 향상시키는 변경 사항에 사용 |
| revert | 이전 커밋을 되돌리는 작업 |
