Commit Convention

Message Structure
type: Subject
body
footer

Commit 메세지는 보통 제목 본문 꼬리말로 작성한다.
어떻게 변경 하였는지 보다 무엇을, 왜 변경 했는지 적는다.

Type

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 포맷팅, 세미콜론 빠졌을 때, 코드 변경이 없는 수정
• refactor : 리팩토링
• test : 테스트 코드 추가, 테스트코드 리팩토링
• chore : 빌드 관련 수정, 패키지 매니저 수정

위 7가지가 보편적이고, 추가로 remove move rename을 사용하기도 함

자세한 commit 참고 링크
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

Subject

• 제목은 50자를 넘기지 않는다.
• 마침표를 붙이지 않는다.
• 과거 시제를 사용하지 않는다.
• 명령어로 작성한다.

Body

• 선택사항이라 작성하지 않아도 된다.
• 부연 설명이 필요할 때 작성한다.

Footer

• 선택 사항이라 작성하지 않아도 된다.
• issue tracker id등 ID같은걸 참조할 때 사용한다.

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속

이하 약속은 커밋 메시지를 English로 작성하는 경우에 최적화되어 있다. 한글 커밋 메시지를 작성하는 경우에는 더 유연하게 적용해도 좋음.

1. 제목과 본문을 한 줄 띄워 분리하기
2. 제목은 영문 기준 50자 이내로
3. 제목 첫글자를 대문자로
4. 제목 끝에 . 금지
5. 제목은 명령조로
6. 본문은 영문 기준 72자마다 줄 바꾸기
7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

참고 링크
https://meetup.toast.com/posts/106