git & github

Git 커밋 메세지 컨벤션

wellbell 2021. 3. 13. 19:48

git로 버전관리를 할때 커밋 메시지를 원칙을 정하고 일관성 있게 작성하기 위한 스타일 가이드 라고 보면된다.

 

구조는 다음과 같다.

 

type: subject

 

body

 

footer

 

type 

feat : 새로운 기능 추가

fix : 버그 수정

docs : 문서 수정

style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우

refactor : 코드 리팩토링

test : 테스트 코드, 리팩토링 테스트 코드 추가

chore : 빌드 업무 수정, 패키지 매니저 수정

 

subject

제목부분으로 50자 이내, 대문자로 작성, 과거시제 사용하지않고 명령어로 작성(영어 기준)

 

Body

선택 사항으로 본문내용을 작성할수도 안할수도 있다.

부연설명이나 커밋 이유를 설명할 경우에 작성하면된다.

72자 이내로 작성하며 제목과 한칸을 띄어 쓴다.

 

footer

선택 사항으로 꼬리말을 작성할수도 안할수도 있다.

이슈, 트래커 id를 작성할때 사용한다.

 

위의 기준에 맞추서 제 프로젝트에 작성했던 커밋 메시지

[fix] Swagger termsOfServiceUrl 수정

 

도메인 수정에 따라서 이전 EC2 주소에서 도메인 주소로 변경

[fix] Swagger termsOfServiceUrl 수정

도메인 수정에 따라서 이전 EC2 주소에서 도메인 주소로 변경