[Git] Commit Message Convention

최진민·2021년 7월 24일
0
post-thumbnail

Git - Commit Message Convention

  • 커밋 메시지는 원칙과 일관성이 필요하다.

1. Commit Message Structure

기본적인 구성은 제목/본문/꼬리말이다.

[Commit Type] : [subject] [body] [footer]

2) Commit Type

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 포맷팅, 세미콜론 누락, 코드 변경 없을 때
  • refactor : 코드 리팩토링
  • test : 테스트 코드, 리팩토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정

3) Subject

  • 제목은 50자를 넘기지 않고, 대문자로 작성하고 마침표를 붙이지 않는다.
  • 과거시제 X, 명령어로 작성
    • Fixed -> Fix
    • Added -> Add

4) Body

  • 선택사항, 모든 커밋에 본문내용을 작성할 필요는 없다.
  • 부연 설명 또는 커밋 이유
  • 72자를 넘기지 않고, 제목(Subject)와 구분짓기 위한 띄어쓰기

  • 선택사항, 모든 커밋에 꼬리말을 작성할 필요는 없다.
  • issue tracker id를 작성할 때 사용

6) Ex

profile
열심히 해보자9999

0개의 댓글