Git Commit Message Convention - min429/WEB4_5_ServerSOS_BE GitHub Wiki

🖤 커밋 메시지 컨벤션

1. 커밋 유형 지정

• 커밋 유형은 영어 소문자로 작성하기
• 커밋 자주하기

커밋태그	의미
feat:	새로운 기능 추가
fix:	버그 수정
docs:	문서 수정
style:	코드 formatting, 세미콜론 누락 등 (코드 자체 변경 없음)
refactor:	코드 리팩토링
test:	테스트 코드, 리팩토링 테스트 코드 추가
chore:	패키지 매니저 수정, 그 외 기타 수정 (예: .gitignore)
comment:	필요한 주석 추가 및 변경
!HOTFIX:	급하게 치명적인 버그를 고쳐야 하는 경우

2. 제목과 본문을 빈행으로 분리

• 커밋 유형 이후 제목과 본문은 한글로 작성하여 내용이 잘 전달될 수 있도록 할 것
• 본문에는 변경한 내용과 이유 설명 (어떻게보다는 무엇 & 왜를 설명)

3. 제목은 영문 기준 50자 이내로 할 것

4. 자신의 코드가 직관적으로 바로 파악할 수 있다고 생각하지 말자

5. 여러가지 항목이 있다면 글머리 기호를 통해 가독성 높이기

- 변경 내용 1
- 변경 내용 2
- 변경 내용 3

ex) feat: ~~

🖤 규칙에 맞는 좋은 커밋메시지를 작성해야 하는 이유

• 팀원과의 소통
• 편리하게 과거 추적 가능
• 나중에 실무에서 익숙해지기 위해