Skip to content

Git Convention

Jump to bottom
Dong Hyun / Lee edited this page Jul 31, 2022 · 2 revisions

Conventional Commit Messages

image

구조

<type>(<scope>): <subject> # 헤더
<BLANK LINE> 
<body>                     # 본문
<BLANK LINE>
<footer>                   # 바닥글
  • <type>: 해당 commit의 성격을 나타냅니다.
  • <body>: 헤더에서 생략한 상세한 내용을 작성합니다. 헤더로 충분히 표현이 가능하다면 생략이 가능합니다.
  • <footer>: 어떤 이슈에서 왔는지와 같은 참조 정보를 추가하는 용도로 사용합니다.

타입 종류

  • feat: 새로운 기능에 대한 커밋
  • fix: 버그 수정에 대한 커밋
  • build: 빌드 관련 파일 수정에 대한 커밋
  • chore: 그 외 자잘한 수정에 대한 커밋(기타 변경)
  • ci: CI 관련 설정 수정에 대한 커밋
  • docs: 문서 수정에 대한 커밋
  • style: 코드 스타일 혹은 포맷 등에 관한 커밋
  • refactor: 코드 리팩토링에 대한 커밋
  • test: 테스트 코드 수정에 대한 커밋

규칙

  1. 제목과 본문을 한 줄 띄워 분리하기
  2. 제목은 영문 기준 50자 이내로 작성하기
  3. 제목 첫글자를 대문자로 작성하기
  4. 제목 끝에 . 사용하지 않기
  5. 제목은 명령조로 사용하기
  6. 본문은 영문 기준 72자마다 줄 바꾸기
  7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
Clone this wiki locally