커밋 작명 규약
아래의 커밋 컨벤션은 conventional commits을 바탕으로 쓰여졌습니다.
타입
설명
예시 또는 비고
chore
사소한 수정을 할 때 쓰입니다
lint
eslint, commitlint, pretitter 등 컨벤션 도구를 다룰 때 쓰입니다.
lint(config), lint(add)
, lint(eslint)
, 아니면 그냥 lint
도 됩니다.
build
크게 데이터 구조가 갱신되었을 때 사용
docs
문서 관련 작업 시
test
단위 및 E2E 테스트 작업에서 사용합니다.
test(write), test(e2e)
feat
feature를 뜻하는 축약 타입. 새로운 기능이 구현 되었을 때 자주 쓰입니다.
일반적으로 TDD 규칙을 따른다면 test
타입의 커밋 직후에 와야 합니다.
fix
오류 및 오타 수정
fix(hot), fix(typo), fix(prisma)
, 아니면 그냥 fix
도 됩니다.
refact
refactor를 뜻하는 축약 타입
revert
커밋 되돌리기, 이전 내용으로 바뀌기 등
style
주로 FE의 UI 구현 작업에 사용됩니다.
hack
문제가 있지만 일단 커밋을 해야 될 때. 임시로 하드코딩을 할 때 주로 사용을 합니다.
merge
병합 커밋을 작성할 때, 반드시 PR 번호를 타입 옵션으로 집어넣어야 합니다.
merge(#7): from test/ci/remove-deps-command
config
도구의 설정을 변경할 때 사용합니다.
config: Remove unneeded paths
types
타입에 관련한 작업
types: Add @types/ws to fix type miss match
Last updated
Was this helpful?