이번에 처음으로 PR을 보내고 내가 작성한 커밋메세지를 봤는데 생각보다 가독성이 떨어지고 난잡해 보였다. 가능한 제목에 모든 걸 상세하게 적으려고 했던 게 화근이었다. 그리고 매번 커밋 메세지 타입을 구글링했던 내가 생각났다. 그래서 이번 기회에 앞으로 사용할 커밋 타입과 커밋메세지 포맷을 정해봤다. 많은 내용 중에 내가 사용할 부분만 요약해서 써봤다.
📌 좋은 커밋 메세지의 중요성
변경사항 또는 버그 발생 시 과거 기록을 추적할 때 시간을 단축할 수 있다.
팀원과의 소통을 원활하게 해준다.
📌 커밋 메세지 형식
타입: 제목(콜론 뒤에 공백을 넣어준다.)
줄바꿈
본문 (본문에서 하이픈 사용 시 뒤에 공백을 넣어준다.)
줄바꿈
바닥글
📌 자주 쓰이는 커밋 메세지 타입
- feat: 기능구현
- refactor: 코드 리팩토링
- test: 테스트 추가, 테스트 리팩토링
- docs: 문서 수정 ex)README.md
- style: 코드포맷, 세미콜론 누락 등 코드 수정이 없는 경우
- fix: 버그 고침
- !BREAKING CHANGE: API 변경 ex)API의 매개변수, 반환값 변경
- rename: 파일, 패키지명 수정
- remove: 파일 삭제
- comment: 주석 관련
- chore: 그 외 자잘한 수정
📌 커밋 메세지 제목
제목의 마지막에 특수문자 삽입하지 않기 ex) 제목.
📌 커밋 메세지 본문
본문 작성 시 줄 바꿈을 해준다. 어떻게 변경했는지보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다. 그 이유는 어떻게 했는지는 코드가 설명할 것이기 때문이다.
기능 구현 커밋메세지를 작성할 때 제목에 구현한 기능을 적고 그에 대한 자세한 내용은 줄 바꿈후 본문에 써서 가독성 높은 커밋 메세지를 작성해봐야겠다.
꾸준하게 쌓아가자