commitlint 컨벤션 모음

commintlint를 사용할 때 가장 많이 쓰는 컨벤션에 대한 설명

bulb

일반적으로 @commitlint/config-conventional에서 제공하는 컨벤션들입니다.

컨벤션

build

  • 빌드 시스템 또는 외부 종속성에 관련된 변경 사항
  • ex) 프로덕션 코드의 변경 없이 빌드 스크립트를 수정한 경우

chore

  • 프로젝트 구성, 도구 설정 등의 일반적인 작업에 관련된 변경 사항
  • ex) 코드 변경 없이 프로젝트 설정을 업데이트하거나, 패키지 의존성을 추가/삭제하는 경우

ci

  • CI 구성 파일 및 스크립트 등 CI 파이프라인에 관련된 변경 사항
  • ex) CI 설정 변경이나 CI 파이프라인 스크립트 수정 등

docs

  • 문서에 관련된 변경 사항
  • ex) 문서 추가, 수정, 삭제 등

feat

  • 새로운 기능 추가에 관련된 변경 사항
  • ex) 새로운 기능이나 기능 개선이 추가된 경우

fix

  • 버그 수정에 관련된 변경 사항
  • ex) 기존의 기능을 수정하여 버그를 해결한 경우

perf

  • 성능 개선에 관련된 변경 사항
  • ex) 코드 변경으로 인해 성능이 개선된 경우

refactor

  • 코드 리팩토링에 관련된 변경 사항
  • ex) 기능을 변경하지 않고 코드의 구조를 개선하거나, 가독성을 높이기 위해 코드를 수정한 경우

revert

  • 이전 커밋을 되돌리는 변경 사항
  • ex) 이전에 커밋한 내용을 취소하거나 이전 상태로 돌아가는 경우

style

  • 코드 스타일, 포맷팅, 주석 등에 관련된 변경 사항
  • ex) 코드 변경이 없고, 주로 들여쓰기, 공백, 세미콜론 등의 스타일 가이드를 따르기 위해 수정한 경우

test

  • 테스트 코드에 관련된 변경 사항
  • ex) 테스트 코드 추가, 수정, 삭제 등

예시

git commit -m 'feat: add button component'
git commit -m 'refactor(archive): code refactoring'