Skip to content
Park Joung Hyeon edited this page Apr 13, 2025 · 1 revision

커밋 메시지 작성 가이드라인

✅ 커밋 유형 표

유형 코드 사용 시점
feat: :sparkles: 새로운 기능 추가
fix: :bug: 버그 수정
docs: :memo: 문서 수정
test: :rotating_light: 테스트 코드 추가 및 수정
refactor: :recycle: 코드 리팩토링 (성능 개선 포함)
chore: :wrench: 빌드 관련 작업, 패키지 매니저 수정
style: :lipstick: 파일/폴더명/변수명 변경
remove :wastebasket: 파일/폴더 삭제

예시

    # 👍 좋은 예
    git commit -m "✨ feat: 사용자 프로필 편집 기능 추가"

    # 👎 나쁜 예
    git commit -m "🚀 기능 추가"  #유형과 자세한 설명 누락!

🚨 작성 규칙

  1. 제목과 본문을 빈행으로 분리:

    • 커밋 유형 이후 제목과 본문을 한글로 작성하여 변경 사항과 그 이유를 설명합니다.
  2. 제목 형식:

    • 첫 글자는 대문자로, 끝에는 .을 넣지 않습니다.
    • 제목은 영문 기준 50자 이내로 작성합니다.
  3. 커밋 메시지 내용:

    • 변경한 내용과 그 이유를 자세히 설명합니다.
    • 여러 항목이 있다면 글머리 기호를 사용하여 목록을 작성합니다.
         - 변경 내용 1
         - 변경 내용 2
         - 변경 내용 3
      

Clone this wiki locally