Git Commit Message Convention - prgrms-web-devcourse-final-project/WEB4_5_GAEPPADAK_BE GitHub Wiki

Git Commit Message Convention

🖤 커밋 메시지 컨벤션

<aside> 👍

1. 커밋 유형 지정

Commit 유형

커밋 유형	의미
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
refactor	코드 리팩토링
test	테스트 코드, 리팩토링 테스트 코드 추가
chore	패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
design	CSS 등 사용자 UI 디자인 변경
comment	필요한 주석 추가 및 변경
rename	파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
remove	파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우

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

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

3. 제목 첫 글자는 대문자로, 끝에는 `.` 금지

4. 제목은 최대한 간결하고 직관적으로 작성

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

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

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

</aside>

✅ 유의 사항

커밋 전 CTRL + ALT + L 적용 (코드 포맷팅 정리)
브랜치에서 변경 사항을 커밋으로 저장
명령어: git add . → git commit -m "내용"
실수로 인한 Commit이 발생하지 않도록 유의

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

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

진행 전 팀원들과 읽어보세요!

https://gggimmin-development-technology.tistory.com/18

⚠️ GitHub.com Fallback ⚠️