Skip to content

Commit Convention

sunmin edited this page Nov 7, 2022 · 1 revision

커밋 형식

<커밋 타입>(<영역>): <커밋 메세지> <관련 이슈 리스트>,

파일명을 제외하면 영어 소문자로 작성 (한글은 무관)

ex)

  • feat(be): 회원가입 API #15
  • docs: api 문서 작성 #14, #16
  • fix: 특정 브라우저에서 로그인이 되지 않는 버그 수정(x)
  • fix: 특정 브라우저에서 로그인이 되지 않음(o)
    • 버그 설명할 때 메세지 바디에 적거나 이슈로 빼서 어떤 버그가 어떻게 재현 가능한지 설명 필요

커밋 타입

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • docs: 문서 관련
  • refactor: 코드 리팩토링
  • build: 빌드 관련 파일 수정
  • test: 테스트 코드 관련
  • chore: 그 외 자잘한 수정

커밋 영역

  • fe
  • be
  • cicd (?)

이외에 레포지토리 전체에 해당하는 경우는 영역 표시 X