Skip to content

커밋 컨벤션

Seoyeong Lee edited this page Oct 3, 2022 · 1 revision

Git 커밋 컨벤션을 문서화합니다.

커밋 메세지 구조


커밋 메세지는 git cz를 이용합니다.

태그 종류


커밋 메세지의 prefix는 다음과 같이 지정합니다.

chore: 사소한 수정내역을 커밋할 때 사용합니다.
docs: 문서 ( Ex. API 명세서, 주석 )를 수정할 때 사용합니다.
feat: 기능을 추가하거나 수정할 때 사용합니다.
fix: 버그를 고칠 때 사용합니다.
hotfix: 급하게 버그를 고칠 때 사용합니다.
refactor: 코드를 리펙토링 하는 경우 사용합니다.
style: 코드의 변경이 없는 상태로 코드의 형식이나 세미콜론등을 수정할 때 사용합니다.
test: 테스트코드를 작성할 때 사용합니다.

이슈번호


이슈를 해결하기 위해 커밋한 경우 태그 뒤 #{이슈번호}를 적어줍니다. 배정된 이슈가 없다면 비워도 무방합니다.

제목


해당 커밋의 내용을 요약해 한 눈에 알 수 있게 작성합니다.

Clone this wiki locally