type(옵션): [#issueNumber - ]Subject -> 제목
(한 줄을 띄워 분리)
body(옵션) -> 본문
(한 줄을 띄워 분리)
footer(옵션) -> 꼬리말
코드 변경 사항에 대한 짧은 요약을 나타낼 것
예시) Feat: 추가 get data api 함수
형식 : 태그: 제목
태그와 제목으로 구성
태그는 영어로 쓰되 첫 문자는 대문자로 작성
항목 | 설명 | 종류 |
---|---|---|
Feat | 새로운 기능 추가 | 기능 |
Fix | 버그 수정 | 기능 |
Design | CSS 등 사용자 UI 디자인 변경 | 기능 |
!BREAKING CHANGE | 커다란 API 변경의 경우 ex) API의 arguments, return 값의 변경 ex) DB 테이블 변경 ex) 급하게 치명적인 버그를 고쳐야 하는 경우 | 기능 |
!HOTFIX | 급하게 치명적인 버그를 고쳐야하는 경우 | 기능 |
Comment | 필요한 주석 추가 및 변경 | 개선 |
Style | 스타일 관련 기능 ex) 코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우 ex) 오타 수정, 탭 사이즈 변경, 변수명 변경 등 | 개선 |
Refactor | 코드 리팩토링 | 개선 |
Docs | 문서 수정 ex) README.md 수정 등 | 기타 |
Test | • 테스트 코드, 리펙토링 테스트 코드 추가(프로덕션 코드 변경 X) • test 폴더 내부 변경이 발생한 경우에만 해당 | 기타 |
Rename | 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 | 기타 |
Remove | 사용하지 않는 파일 혹은 폴더를 삭제하는 경우 | 기타 |
Chore | • 빌드 업무 수정, 패키지 매니저 수정 • 모듈의 변경 ex) .gitignore 수정 ex) package.json 변경 ex) dotenv의 요소 변경 |
기능 태그의 경우 괄호 안에 추가적인 문맥 정보 제공 가능
ex)
"Feat(navigation): "
"Fix(database): "
Feat: 수정 회원가입 함수
회원가입 함수 오류 수정
Resolves: #111
Ref: #432
Related to: #4, #7