728x90
Commit Convention은 간단하게 말해 협업할 때 Commit Message에 대한 서로간의 약속 입니다.
Commit Structure
커밋 메시지에 대한 약속.
커밋 메시지 구조는 크게 3가지로 나뉩니다 (제목, 본문, 꼬리말)
type: Subject -> 제목
(한칸 띄우기)
body(생략 가능) -> 본문
(한칸 띄우기)
footer(생략 가능) -> 꼬리말
각 커밋 메시지 구조에는 규칙이 존재합니다.
Commit Type
Subject Rule
1. 제목은 최대 50글자 넘지 않기
2. 마침표 및 특수기호 사용x
3. 첫 글자 대문자, 명령문 사용
4. 개조식 구문으로 작성(간결하고 요점적인 서술)
Body Rule
1. 한 줄당 72자 내로 작성
2. 최대한 상세히 작성
3. 어떻게 보다는 '무엇을', '왜' 변경했는지에 대해 작성
Footer Rule
1. 유형: #이슈 번호의 형식으로 작성
2. 이슈 트래커 ID를 작성
3. 여러개의 이슈 번호는 ,로 구분
4. 이슈 트래커 유형은 아래와 같다
커밋 예시
signin, signup 기능이 추가되었다고 가정해보면,
커밋 메시지는 아래와 같을 것입니다.
Feat: Add signin, signup
회원가입 기능, 로그인 기능 추가(예시를 위해 간단히 작성)
Resolves: #1
