ect
[Git] git commit convention
sohyeonnn
2023. 5. 28. 20:41
Git Commit Convention
각종 프로젝트를 하다 보면 git에 commit 해야하는 상황이 온다. 글을 작성하며 유다시티의 깃 커밋 컨벤션을 참고했다.
Message Structure
커밋 메세지는 아래와 같이 커밋 타입/제목/본문/꼬리말 로 구분된다.
type: Subject
body
footer
Type
- feat: 새로운 기능 추가
- fix: 버그 수정
- docs: 문서 수정
- style: 포맷팅, 세미콜론 빠졌을때, 코드 변경이 없는 수정
- refactor: 코드 리팩토링(자잘한 변경에도 사용될 수 있다, 변수/함수명을 바꾸는것도 포함된다.)
- test: 테스트 코드 추가, 테스트코드 리팩토링
- chore: 빌드관련 수정, 패키지 매니저 수정
위는 유다시티에서 제안하는 커밋 메시지 타입이고 추가로 아래 메세지도 사용할 수 있다.
build: 빌드 설정 파일 관련
ci: ci 관련 설정 수정
design: css 등 사용자 UI 작성, 변경
Subject
제목은 50자 이내로 적는다. 시작은 대문자로 적고 끝에 온점(.)을 붙이지 않는다.
과거 시제로 작성하지 않고 명령어로 작성한다.
예를 들어, 아래와 같이 changed, changes 가 아닌, change로 작성한다.
fix: Change version
Body
본문 작성은 선택사항이다.
본문은 주로 부연설명이 필요할때 작성하며, 어떻게 구현했는지가 아닌 무엇을, 왜 구현했는지를 담아야한다.
본문을 작성할때 제목과 본문 사이에 공백 줄을 넣어야 하며, 72자 이내로 작성한다.
Footer
꼬리말도 본문처럼 선택사항이다.
주로 issue tracker ID를 참조할 때 사용된다.
Resolves: #123
See also: #456, #789
참고