더 나은 git 커밋 메시지 작성을 위한 패턴

내가 전달하는 내용의 맥락과 함께 멋진 커밋 메시지를 작성하고 있는지 의심이 들 때마다 참조하기 위해 항상 가지고 다니는 독단적인 가이드입니다.

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

제대로 구성된 Git 커밋 제목 줄은 항상 다음 문장을 완성할 수 있어야 합니다.If applied, this commit <will your subject line here>

커밋 샘플

아래 커밋의 예를 참조하십시오.

[type](optional scope): [subject]

[optional body]

[optional footer]

유형

다음 중 하나여야 합니다.

빌드 - 빌드 관련 변경 사항

ci - CI 관련 변경 사항

자질구레한 - 빌드 프로세스 또는 보조 도구 변경

문서 - 설명서만 변경됨

feat - 새로운 기능

수정 - 버그 수정

perf - 성능을 향상시키는 코드 변경

리팩터링 - 버그를 수정하거나 기능을 추가하지 않는 코드 변경

되돌리기 - 되돌리기

스타일 - 마크업, 공백, 서식 지정, 세미콜론 누락...

테스트 - 누락된 테스트 추가

범위

범위는 추가 컨텍스트 정보를 제공하기 위해 커밋 유형에 제공될 수 있으며 괄호 안에 포함됩니다(예: feat(parser): 배열을 구문 분석하는 기능 추가).

주제

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

명령형 현재 시제 사용: "변경"또는 "변경"이 아닌 "변경"

끝에 점(.)이 없습니다.

신체

주어에서와 마찬가지로 명령형 현재 시제를 사용합니다. "변경"또는 "변경"이 아닌 "변경"입니다. 신체는 변화에 대한 동기를 포함하고 이를 이전 행동과 대조해야 합니다.

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

제목을 빈 줄로 본문에서 분리

제목 줄을 50자로 제한

현재 시제로 요약합니다. 대문자가 아닙니다.

마침표로 제목 줄을 끝내지 마십시오

.

제목 줄에 명령형 분위기 사용

72자로 본문을 감싸세요.

본문을 사용하여 무엇을, 왜 대 어떻게 설명하세요

커밋 템플릿

Go to my git commit template

참조

How to Write a Git Commit Message by Chris Beams

Why Use Conventional Commits

@commitlint/config-conventional

commit-messages-guide