Commit Message Convention

Git 저장소에서 사용되는 커밋 메시지 형식을 정의하는 규칙입니다!

---

why

이 규칙을 따르면 커밋 메시지를 일관되고 의미 있는 방식으로 작성할 수 있습니다.

쉽게말해 알아보기 쉽게 하기 위해서 쓰는것입니다!

---

Before

저는 처음에 커밋 메시지에도 규칙이 있는지 몰랐습니다..

그래도 나름 보기 편하게 작성했다고 생각했지만 점점 가독성이 떨어지고 일관적이지 못하니까 보기 불편하더라구요!!

After

훨씬 깔끔하지않나요?!

---

Rules

1. 제목과 본문을 빈 행으로 구분
2. 제목은 50글자 이내로 제한
3. 제목의 첫 글자는 대문자로 작성
4. 제목 끝에는 마침표를 넣지 않음
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않음
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명
   
   
   
   

---

구조

type(옵션): [#issueNumber-] Subject // Header 제목
body(옵션) // 본문
footer(옵션) // 꼬리말

타입

커밋의 종류를 나타내며, 주로 다음과 같이 사용

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 스타일 변경 (공백, 포맷팅 등)
• refactor: 코드 리팩토링
• test: 테스트 코드 추가 또는 수정
• chore: 빌드 프로세스 또는 도구 관련 변경

제목

코드의 변경 사항에 대해 짧은 요약

"메시지"는 커밋에 대한 간단하고 명확한 설명을 제공합니다. 커밋 메시지를 작성할 때는 명령문 형식으로 작성하고, 가능한 한 간결하고 명확하게 작성하는 것이 좋습니다.

Commit Message Convention을 사용하면 프로젝트의 커밋 히스토리를 쉽게 읽고 이해할 수 있으며, 협업과 코드 리뷰를 원활하게 진행할 수 있습니다.

본문

선택사항으로 부연설명이 필요하거나 커밋의 이유를 설명할 경우 자성

footer

선택사항이며 issue tracker id 작성시 사용

• 형식 : 유형 : #이슈번호

• 유형

  • Fixes : 이슈 수정중 (아직 해결되지 않은 경우)
  • Resolves : 이슈를 해결했을 때 사용
  • Ref : 참고할 이슈가 있을 때 사용
  • Related to : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

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

• 참고

  • https://velog.io/@msung99/Git-Commit-Message-Convension
  • https://velog.io/@chojs28/Git-커밋-메시지-규칙