TIL-Git Commit Message Convention

2024-05-07

오늘의 학습 🌠

---

Git Commit Message Convention

---

Commit Message Structure

제목 (Type : subject)
(`한줄 띄어 분리`)
본문 (Body)
(`한줄 띄어 분리`)
꼬리말 (Footer)

Commit Type

• 태그 : 제목 :(space) 제목으로 : 뒤에만 space를 넣음.

• feat : 새로운 기능 추가

• fix : 버그 수정

• docs : 문서 수정

• design : CSS 등 사용자 UI 디자인 변경

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

• refactor : 코드 리펙토링

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

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

Subject

• 제목은 50글자 이내로 작성

• 첫글자는 대문자로 작성

• 마침표 및 특수기호는 사용하지 않음

• 과거시제 사용하지 않음

Body

• 선택사항으로 모든 커밋에 본문 내용을 작성할 필요는 없음

footer

• 선택사항으로 모든 커밋에 꼬리말을 작성할 필요는 없음

• 유형 : # 이슈 번호 형식으로 작성함

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

Example

• 예시

    Feat: 회원 가입 기능 구현
  
    SMS, 이메일 중복확인 API 개발
  
    Resolves: #123
    Ref: #456
    Related to: #48, #45
  

🐱‍🏍— —🤸🏻‍♀️ ~~~ 야~호~