커밋 메시지 컨벤션?
이곳 + 이곳을 참조하여 정리된 블로그들을 다시 참조하여 커밋 메시지 컨벤션을 정리
1. 커밋 메시지 구조
- 제목(subject), 본문(body), 꼬리말(footer)로 이루이지며 각 파트는 한줄을 띄워서 분리
type: subject
body
footer2. 제목
- 타입 + 제목으로 이루어짐
- 참고한 곳에서 타입에 대한 설명이 있지만 나는 타입으로 깃모지를 사용할 것이라서 패스
- 제목은 50자 이내로, 첫글자는 대문자로 하고 마침표 X
- 제목은 명령형으로 작성
3. 본문
- 필수 X
- 한줄에 72자 이내
- 길어도 되니까 상세히 작성
- 어떻게 변경했는지 보다, 무엇을 또는 왜 변경했는지 작성
4. 꼬리말
- 필수 X
- 이슈트래커 ID를 참조할 때 사용한다
- "타입: #이슈트래커 ID"
- 이슈트래커 타입
Fixes: 이슈 수정 중 (아직 해결 X)
Resolves: 이슈 해결
Ref: 참고할 이슈가 있을 때
Related to: 해당 커밋에 관련된 이슈ID (아직 해결 X)
5. 깃모지
- 사실 이거 쓰고싶어서 커밋 컨벤션 정리함
- 링크
- 제목의 타입에 이모지를 사용
- 이모지마다 의미가 있어서 이모지만 보고 커밋 의도 파악 가능
- vscode extention에도 있음
6. 커밋 메시지 템플릿
- 위에서 정리한 컨벤션 기반으로 템플릿 작성
- 템플릿 작성 및 적용은 여기 참고함
# <타입>: <제목>
# <본문>
# <꼬리말>
##### 제목 #####
# 타입 : 깃모지 - https://gitmoji.dev/
# 50자 이내로 하고 마침표 X
# 명령형으로 작성
##### 본문 #####
# 필수 X
# 상세히 작성
# !어떻게! 변경했는지 보다는, !무엇을! 또는 !왜! 변경했는지 작성
##### 꼬리말 #####
# 필수 X
# 이슈트래커 ID 참조할때 주로 사용
# 예시) Resolves: #123
# Fixes : 이슈 수정 중 (아직 해결 X)
# Resolves : 이슈 해결
# Ref : 참고할 이슈
# Related to : 해당 커밋에 관련된 이슈 (아직 해결 X)
hi