평소에 add, modify, delete 등 한 단어로만 메시지를 작성했었는데 문득 성의 없어 보인다는 생각이 들었다.
그래서 다른 사람들은 어떻게 작성하고 있나 궁금해서 찾아본 내용 중에 마음에 드는 규칙을 정리했고,
앞으로 아래와 같이 작성할 것이다.
구조
타입: 메시지
규칙
- 동명사보다 명사를 사용하기
- 관사는 사용하지 않기
- 부정문 Don’t를 사용하기
타입
- feat : 표면적으로 새로운 기능을 추가했을 때
- fix: 오류를 수정했을 때
- docs: 문서를 수정했을 때
- style: 포맷이나 세미콜론을 놓친 것과 같은 부분을 수정했을 때
- design: UI 디자인 변경했을 때
- refactor: 코드를 리팩토링했을 때
- test: 테스트 코드를 추가 혹은 수정했을 때
- chore: 자질구레한 일들을 했을 때
좋은 커밋 메시지를 위한 영어 단어 목록
- fix : 올바르지 않은 동작을 고쳤을 때
- add : 코드, 테스트, 예제, 문서 등을 추가했을 때
- remove : 코드를 삭제했을 때
- simplify : 복잡한 코드를 단순화할 때
- update : 정상적으로 동작하고 있었지만 수정, 추가 보완할 때
- improve : 호환성, 성능, 접근성 등의 향상이 있을 때
- make : 기존 동작을 변경할 때
- revise : 문서의 개정이 있을 때
- prevent : 특정한 처리를 못하게 막을 때
- move : 코드의 이동이 있을 때
- rename : 이름을 변경할 때
⬇️ 출처