Skip to content

Commit Message Style Guide

YoonSung Kim edited this page Mar 9, 2023 · 1 revision

Message structure

type(option): subject (#issue id)
\n
body
\n
footer(option)

Subject types

feat: 신규 개발
fix: 버그를 고침
design: Ui 변경
!BREAKING CHANGE: 큰 변화가 있는 경우
!HOTFIX: 그 밖에 치명적인 버그를 고쳐야하는 경우
style: 코드 포맷만 변경
refactor: 리팩토링
perf: 성능개선
comment: 주석 관련
docs: 문서 수정
test: 테스트 코드 관련
chore: 빌드 태스크, 패키지 매니저 설정
rename: 파일, 폴더 이름이나 위치 변경
remove: 파일 삭제
add: 기타 문서, 파일 추가

Footer types

resolves: 해결
resolving: 해결 중
fixes: 수정 중
ref: 참고
related to: 관련 이슈(해결 x)

Example

feat(map): add map init (#2)

1. add map constant
2. init map
3. add osm

resolving: #2
related to: #1
Clone this wiki locally