-
Notifications
You must be signed in to change notification settings - Fork 0
Commit Convention
suhyun_ edited this page Oct 9, 2024
·
1 revision
커밋 유형 | 의미 |
---|---|
Init | 프로젝트 생성 |
Feat | 새로운 기능 추가 |
Fix | 버그 수정 |
Docs | 문서 수정 |
Style | 코드 formatting, 세미콜론(;) 누락, 코드 자체의 변경이 없는 경우 |
Refactor | 코드 리팩토링 |
Test | 테스트 코드, 리팩토링 테스트 코드 추가 |
Chore | 빌드 업무 수정, 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore |
Design | 디자인 적용 및 디자인 관련 코드 수정(CSS 등 사용자 UI 디자인 변경) |
커밋 메시지 작성 형식 : 커밋 유형: 커밋 내용
의 형태이며, :
뒤에만 space가 있음에 유의한다.
- 커밋 유형은 영어로 쓰되 첫 문자는 대문자로 작성한다.
- 커밋 내용은 최대 40글자가 넘지 않도록 하고 마침표 및 특수 기호는 사용하지 않는다.
- 한 커밋 내용에는 가급적이면 하나의 일만 작성한다.
- 커밋 내용은 한글로 작성하며 개조식 구문으로 작성한다.(완전한 서술형 문장이 아니라, 간결하고 요점적으로 서술한다.)
ex) Commit 예시
Feat: 사용자 닉네임 모달창 구현 # 새로운 기능 추가 작업
Feat: 시작 버튼 구현 # 새로운 기능 추가 작업
Bug: 시작 화면 오류 수정 # 버그 수정 작업
Refactor: 코드 줄바꿈 # 코드 리펙토링
Design: 스테이지1 색상 변경 # 디자인 적용 및 디자인 관련 코드 수정