Skip to content

Commit Convention

LegendPaino edited this page Feb 17, 2023 · 4 revisions

✅ git-commit-convention

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • add: 코드 추가
  • test: 테스트 코드 추가
  • refactor: 코드 리팩토링
  • style: 스타일 수정
  • chore: 기타
  • docs: 문서 수정
  • merge: 가져온 브랜치 => 병합한 브랜치

✅ commit-rules

  • Subject(제목)

    • 커밋 메시지 타입 첫 글자는 대문자로 작성한다.
  • Body(설명)

    • 작업 설명글을 작성한다.
  • Footer

    • issue tracker ID 명시하고 싶은 경우에 작성한다.
    • 여러 개의 이슈번호는 쉼표(,)로 구분한다.
    • 이슈 트래커 유형은 다음 중 하나를 사용한다.
      Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
      Resolves: 이슈를 해결했을 때 사용
      Ref: 참고할 이슈가 있을 때 사용
      Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

✅ commit-example

Feat: "회원 가입 기능 구현"

SMS, 이메일 중복확인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45

Clone this wiki locally