[Git] Git Commit Convention

Git Commit Convention

Git Commit Convention은 소스 코드의 변경 사항을 기록할 때, 커밋 메시지에 일정한 형식을 적용하는 규칙이다. 이 규칙을 통해 프로젝트 내의 모든 사람이 일관된 방식으로 커밋 메시지를 작성할 수 있게 되어, 변경 사항을 쉽게 추적하고 이해할 수 있다.

 

---

커밋 컨벤션 기본 형식

<type>(<scope>): <subject>

• type: 커밋의 종류를 나타내며, 일반적으로 feat (새로운 기능), fix (버그 수정), docs (문서 수정), style (코드 포맷팅 수정), refactor (코드 리팩토링), test (테스트 추가/수정), chore (빌드 과정 또는 도구와 관련된 수정) 등이 사용된다.
• scope (선택 사항): 변경된 파일이나 컴포넌트를 명시한다.
• subject: 변경 사항의 짧은 설명이며, 50자 이내로 작성하는 것이 일반적이다.

 

예시

feat(auth): add JWT authentication
fix(ui): resolve button alignment issue

 

 

Commit Type

Type	사용 시점
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등) 기능 수정이 없는 경우
design	사용자 UI 디자인 변경 (CSS 등)
comment	필요한 주석 추가 및 변경
test	테스트 코드, 리팩토링 테스트 코드 추가
refactor	코드 리팩토링
build	빌드 파일 수정
ci	CI 설정 파일 수정
pref	성능 개선
chore	빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
rename	파일 혹은 폴더명을 수정만한 경우
remove	파일을 삭제만 한 경우

 

---

 

[참고 자료]

https://jane-aeiou.tistory.com/93

https://kdjun97.github.io/git-github/commit-convention/