@ive-korea/commit-convention

@ive-korea/commit-convention은 프로젝트에서 커밋 메시지 규칙을 자동으로 설정하고 적용하는 도구입니다.

Husky와 Commitlint를 통합하여 일관된 커밋 메시지 규칙을 쉽게 유지할 수 있습니다.

프로젝트 초기 설치하여 일관성 있는 커밋을 작성할 수 있습니다.

설치

npx @ive-korea/commit-convention

사용방법

{사용하고 있는 패키지} commit

ex) pnpm commit
ex) yarn commit 
ex) npm run commit

지원하는 커밋 타입

  feat: "✨ 새로운 기능을 추가했어요.",
  fix: "🐛 버그를 수정 했어요.",
  docs: "📚 문서만 변경했어요.",
  style: "💎 코드의 영향을 미치지 않는 스타일 변경 (예: 공백, 포맷팅, 세미콜론 등)했어요.",
  refactor: "📦 버그를 수정하거나 기능을 추가하지 않는 코드 변경했어요.",
  perf: "🚀 성능 향상 코드 변경했어요.",
  test: "🚨 테스트 추가 또는 기존 테스트 수정했어요.",
  build: "🛠 빌드 시스템 또는 외부 종속성 변경했어요.",
  ci: "⚙️ CI 설정 파일 또는 스크립트를 변경했어요.",
  chore: "♻️ 소스 코드나 테스트 파일을 수정하지 않는 기타 잡다한 작업을 했어요.",
  remove: "🗑 파일 또는 폴더를 삭제했어요.",
  wip: "🚧 working in progress. 작업중의 준말이에요.",
  asset: "📄 이미지, 폰트 등 정적 파일이 추가 되었어요.",
  story: "🖼️ 스토리북 관련 코드가 변경되었어요.",
  conflict: "🔄 merge conflict를 해결했어요.",
  rename: "✏️ 파일 또는 폴더명을 수정 또는 이동했어요."