[Git] 커밋 메세지 컨벤션

SunowMin·2025년 7월 22일
0

Git

목록 보기
3/3

1. 유다시티 스타일의 커밋 메세지 컨벤션 구조

  • 기본 적인 커밋 메시지 구조는 제목,본문,꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분

type : subject 

body 

footer
  • type : 어떤 의도로 커밋했는지 명시
  • subject : 최대 50글자를 넘지 않도록 하고 마침표는 찍지 않음. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기
  • (option) body : 긴 설명이 필요한 경우 작성, 무엇을 왜 했는지를 중점으로 작성
  • (option) footer : issue tracker ID를 명시하고 싶은 경우에 작성

2. type(제목) : subject은 어떻게 작성하는가?

타입 (Type)

타입설명
feat새로운 기능 추가
fix버그 수정
docs문서 수정 (README 등)
style코드 스타일 수정 (포매팅, 세미콜론 등)
refactor코드 리팩토링 (기능 변경 없이 구조 개선)
perf성능 향상 관련 변경
test테스트 코드 추가/수정
chore빌드/패키지 매니저 설정 등 기타 변경
ciCI 관련 설정 변경
build빌드 관련 파일 수정
revert이전 커밋 되돌리기

제목 (Subject)

  • 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
  • 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다.(과거 시제를 사용하지 않는다.)
  • 제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미
* Fixed --> Fix
* Added --> Add
* Modified --> Modify

3. Body(본문)는 어떻게 작성하는가?

본문은 한 줄 당 72자 내로 작성

본문 내용은 제목과 달리 양에 구애받지 않고 최대한 상세히 작성

어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성


4. Footer(꼬리말)는 어떻게 작성하는가?

꼬리말은 선택사항이고, 이슈 트래커 ID를 작성

꼬리말 형식 : 유형 : # 이슈 번호

여러 개의 이슈 번호를 적을 때는 쉼표로 구분

이슈 트래커 유형설명
Fixesissue 수정중( 아직 해결 안됨 )
Resolvesissue 해결 완료
Ref참고할 issue 존재 시
Related to해당 커밋에 관련된 이슈 번호( 아직 해결 안됨 )

ex) Fixes: #45 Related to: #34, #23


5. 예시

Feat : 추가 조회 메소드 추가

로그인 API 개발

Resolves: #123

Ref: #456

Related to : #100

0개의 댓글