Commit Convention

Frontend Commit Convention

프론트엔드 커밋 컨벤션에 대한 문서입니다. Console, Design System, Core Lib

커밋 메시지 구조

<타입>[적용 범위(선택 사항)]: <설명>

[본문(선택 사항)]

[꼬리말(선택 사항)]

커밋 메시지 구조적 요소

TypeDescriptionRemark
fixBug Fix
API 변경 사항 없이 내부 수정		PATCH
feat기능 추가
API 변경 (하위 호환)		MINOR
perf성능 향상을 위한 코드 변경MAJOR
BREAKING CHANGEAPI 의 변경, 큰 변화MAJOR
refactor내부적인 리팩토링앵귤러 컨벤션
ciCI 변경 (workflow, etc)앵귤러 컨벤션
buildbuild 관련 변경 (webpack, dependencies, etc)앵귤러 컨벤션
docs문서 작성, 수정앵귤러 컨벤션
style코드 의미적으로는 변하지 않는 커밋 (css, formatting, missing semi-colons, etc)앵귤러 컨벤션
revert이전 커밋으로 revert앵귤러 컨벤션
chore그 외 자잘한 수정앵귤러 컨벤션

주의 사항

  1. 반드시 커밋 메시지 구조에 맞는 메시지를 작성하여야 합니다.
    1. 컨벤션과 다를 시, commitLint 에 의해 commit 이 fail 할 수 있습니다.
  2. 타입 뿐 아니라 적용 범위, 설명, 본문, 꼬리말 모두 영어로 작성하는 것을 지향합니다.

References