커밋 메시지는 아래 유형 중 하나를 선택하여 대문자로 작성합니다.
| 커밋 유형 | 의미 |
|---|---|
Feat |
새로운 기능 추가 |
Fix |
버그 수정 |
Docs |
문서 수정 |
Style |
코드 포매팅 (코드 변경 X, 세미콜론 누락 등) |
Refactor |
코드 리팩토링 |
Test |
테스트 코드 추가 및 리팩토링 |
Chore |
기타 변경 사항 (ex: .gitignore 수정) |
Design |
CSS 등 UI 디자인 변경 |
Comment |
주석 추가 및 변경 |
Rename |
파일/폴더 이름 변경 |
Remove |
파일/폴더 삭제 |
!BREAKING CHANGE |
주요 API 변경 |
!HOTFIX |
치명적인 버그 급히 수정 |
예시:
Feat: 사용자 로그인 기능 구현 (#1)
- 제목과 본문 사이에는 빈 줄을 추가합니다.
- 본문에는 변경 내용과 이유를 작성합니다.
(어떻게보다는 무엇과 왜를 중심으로 설명)
- 제목은 첫 글자를 대문자로 시작하며, 끝에
.금지. - 영문 기준 50자 이내로 작성.
여러 변경 사항이 있을 경우 글머리 기호를 사용합니다.
- 변경 내용 1
- 변경 내용 2
- 변경 내용 3
자신의 코드가 직관적으로 파악되지 않을 수 있으므로 상세히 작성합니다.
feat, refactor, fix, chore와 함께 이슈 번호를 포함해 브랜치를 생성합니다.
예시: feat/#34
브랜치를 생성할 때 develop 브랜치를 기준으로 만듭니다.
- issue 제작
create a branch클릭 후 이름 지정. (브랜치 연결 과정, PR시 용이)