[VCS] 좋은 커밋 메세지 간단 작성법

참고 페이지의 간소화 버전이다. 아주 조금의 신경을 쓰면 명확하게 전달되는 커밋 메세지를 작성할 수 있다.

commit message 구조

  <타입>[적용 범위(선택 사항)]: <설명>

  [본문(선택 사항)]

  [꼬리말(선택 사항)]

1. 타입

• commit 이 무엇애 대한 작업인지 키워드를 통해 인지
  • fix: - 버그 수정
  • feat: - 새로운 기능 추가, 기존 기능 변경
  • build: - 빌드 관련 수정
  • ci: - CI 관련 수정
  • docs: - 문서(주석) 수정
  • style: 코드 스타일, 포멧팅 수정
  • refactor: - 코드 리팩토링 (기능 수정 아님. )
  • test: - 테스트 코드 추가, 수정
  • chore: 기타 변경사항 수정 (.gitignore 등)

2. 설명

• 커밋 메시지 제목
  • 제목은 50자를 넘기지 않고, 마침표를 붙이지 않기
  • 제목에 커밋 타입을 함께 작성
  • 과거 시제를 사용하지 않고 명령조로 작성
  • 제목과 본문은 한 줄 띄워 분리
  • 제목의 첫 글자는 반드시 대문자로
  • 이슈에 관련된 내용이라면 이슈 번호를 붙히기

3. 본문

• 자세한 설명

4. 꼬릿말

• 이슈 번호 등

---

참고 : https://www.conventionalcommits.org/ko/v1.0.0/#%ea%b0%9c%ec%9a%94