Conventional Commit Rules

Conventional Commit Rules는 커밋 메시지에 일관된 형식을 부여하는 규칙

 

기본 구조

커밋 메시지는 아래와 같은 형식을 따름

<type>(optional scope): <description>

• type: 커밋의 목적
• optional scope: (선택 사항) 영향을 받는 코드 영역이나 모듈을 명시
• description: 커밋 내용(한 줄 권장)

예시)

feat(auth): add login functionality
fix(api): resolve error on data fetching
docs(readme): update installation instructions

 

주요 타입

• feat: 새로운 기능 추가
  예: feat(ui): add dark mode support
• fix: 버그 수정
  예: fix(auth): correct login token validation
• docs: 문서 관련 변경
  예: docs: update API usage guidelines
• style: 코드 포맷팅, 세미콜론 누락, 들여쓰기 등 코드의 의미에 영향을 주지 않는 변경
  예: style: reformat code according to eslint rules
• refactor: 코드 리팩토링, 기능 추가나 버그 수정이 아닌 구조 개선
  예: refactor(api): simplify request handler logic
• perf: 성능 개선
  예: perf: optimize data processing algorithm
• test: 테스트 코드 추가 및 수정
  예: test: add unit tests for login module
• build: 빌드 시스템 또는 외부 종속성 변경
  예: build: update webpack configuration
• ci: CI 관련 설정 변경
  예: ci: configure GitHub Actions for CI pipeline
• chore: 기타 자잘한 변경, 유지보수 작업 (빌드, 문서, 테스트 코드 외의 일반적인 작업)
  예: chore: add axios instance for API calls
• revert: 이전 커밋 되돌리기
  예: revert: revert commit 1234567