dev.to 의 Helder Burato Berto님 이 작성한 Patterns for writing better git commit messages 번역 자료입니다. 번역에 문제가 있다면 댓글 달아주시구요. 원문을 보시기를 추천드립니다

블로그에 노트를 작성하여 Git 커밋 메시지를 작성하기 위해 일반적으로 따르는 몇 가지 패턴과 방법을 공유했습니다.

좋은 커밋은 다음 문장을 완성해야합니다.

올바르게 구성된 Git 커밋 Subject(제목)는 항상 다음 문장을 완성 할 수 있어야합니다:

이 커밋이 적용된다면 <제목은 여기에>

커밋 샘플

아래 커밋의 예를 참조하세요:

[type](선택적 scope): [subject]

[선택적 body]

[선택적 footer]

Types

다음 중 하나여야 합니다.

  • build - 빌드에 관련된 변경
  • ci - CI 관련 변경
  • chore - 빌드 프로세스 또는 보조 툴 변경
  • docs - 문서만 변경
  • feat - 새로운 기능
  • fix - 버그 픽스
  • perf - 성능을 향상시키는 코드 변경
  • refactor - 버그를 수정하거나 기능을 추가하지 않는 코드 변경
  • revert - 되돌리기
  • style - Markup, white-space, formatting, missing semi-colons…
  • test - 누락된 테스트 추가

Scope

추가 컨텍스트 정보를 제공하기 위해 커밋 타입에 범위를 제공 할 수 있으며 괄호 안에 포함됩니다.

예 : feat (parser) : 배열 구문 분석 기능 추가

Subject(제목)

Subject에는 변경에 대한 간결한 설명이 포함되어 있습니다.

  • 명령형 현재 시제 사용 : “changes”, “changed”가 아닌 “change”
  • 끝에 점(.) 이 없습니다.

Body(본문)

Subject와 마찬가지로 명령형, 현재 시제를 사용하세요. “changes”, “changed”가 아닌 “change”입니다. Body는 변경에 대한 동기를 포함하고 이전 행동과 이것을 대조해야합니다.

훌륭한 커밋 메시지의 7 가지 규칙 :

  1. 빈줄로 Subject(제목)과 Body(제목)를 분리
  2. Subject를 50자로 제한
  3. Subject를 대문자로
  4. 마침표로 제목을 끝내지 마세요.
  5. Subject에 명령적 분위기(imperative mood)를 사용하세요.
  6. Body를 72자로 감쌉니다.
  7. Body를 사용하여 무엇(what)과 왜(why) vs 어떻게(how)를 설명하세요.

커밋 템플릿

내 git commit 템플릿으로 이동

References