commit-convention.md

📝 커밋 컨벤션

이 문서는 본 프로젝트의 Git 커밋 메시지 작성 규칙을 정의합니다.

🧱 기본 형식

${tag}: ${커밋 내용} (${이슈 번호})

예시

feat: 로그인 API 연동 (#17)
fix: 날짜 포맷 오류 수정 (#23)
docs: README 설치 섹션 보강 (#8)

💡 이슈 번호는 브랜치명에서 자동 추출됩니다. 개발자는 제목 본문만 입력하면 되고, .husky/prepare-commit-msg 훅이 (#17) 같은 꼬리표를 자동으로 붙여줍니다. 이 동작은 브랜치명이 feat/#17-login-api 처럼 # 패턴을 포함할 때에만 동작합니다.

🏷️ 커밋 태그

태그	설명
feat	새로운 기능 추가
fix	버그 수정
refactor	기능 변화 없는 코드 리팩토링
test	테스트 추가/수정
docs	문서 변경
style	코드 포매팅
chore	빌드/도구/의존성 관련 기타 작업
ci	CI 설정 변경
perf	성능 개선
build	빌드 시스템/패키지 매니저 변경
revert	이전 커밋 되돌리기

✍️ 작성 규칙

1. 제목은 명령형으로 작성하고, 제목 끝에 마침표 붙이지 않기
2. 제목은 50자 이내를 권장하며, 이슈 번호 포함 최대 100자까지 허용
3. 여러 변경사항이 섞일 경우 본문(blank line 이후)에 bullet으로 분리하기

예시

feat: 일기 작성 에디터 추가 (#42)

- 마크다운 지원
- 태그 자동 완성 드롭다운

🛡️ 자동 검증

• commit-msg 훅이 commitlint 로 형식을 검증합니다.
• pre-commit 훅이 lint-staged 를 통해 Biome 포맷/린트를 자동 적용합니다.
• prepare-commit-msg 훅이 브랜치명에서 이슈 번호를 자동으로 제목에 추가합니다.

검증 설정 파일: commitlint.config.js