Commit Message Convention

개인적으로 사용하기 위해 작성하는 커밋 메세지 컨벤션이다.

사용목적

커밋메세지는 간결하지만 커밋한 목적을 볼 수 있도록 하기 위함
디테일한 커밋의 내용은 PR에 작성해도 될 거 같아 디테일한 커밋 내역은 작성하지 않음

작성 순서

Type: (#Issue) Title (Tail)

Type 종류

[기능]: 신규 기능 추가
[버그]: 버그 픽스
[문서]: 문서 추가 및 수정
[스타일]: 코딩 스타일 관련 or 주석 수정이 있을 때
[리팩토링]: 코드리팩토링이 진행 됐을 때
[테스트]: 테스트케이스가 추가 혹은 수정되었을 때
[설정]: 설정 관련된 내용이 수정되었을 때

Issue는 해당 이슈가 발행되어서 그 이슈번호에 대한 수정이 이뤄졌을때 작성하고 이슈가 없다면 생략 가능

Title

해당 커밋이 발생한 주요 내용

Tail

[완료] : 완료된 작업
[진행] : 진행중이지만 중간 커밋이 필요한 경우

[참고] 다른 형태의 커밋 메세지

type: Subject
(공백)
body
(공백)
footer

이런 형태를 사용하는 경우는 바디에 커밋한 디테일 내용을 작성하는 형태인데
커밋의 타이틀과 이슈번호만 있더라도 기본적인 커밋내용을 알 수 있을거라 생각해서 바디와 푸터 대신 타이틀에 디테일 한 내용을 작성하는 형식으로 작성하려고 한다

참고링크

https://velog.io/@jiggyjiggy/Git-commit-convention-type-subject%EC%9D%98-%EC%A4%91%EC%9A%94%EC%84%B1
https://github.com/yj-oh/til/blob/main/git/%5B20200804%5D_%EB%82%98%EB%A7%8C%EC%9D%98_commit_message_conventions.md