Git 커밋 메시지 작성을 위한 7가지 규칙

더 깨끗하고 의미 있는 Git 커밋 메시지의 세계에 오신 것을 환영합니다! 일부 구조화된 사례를 채택하면 커밋 로그가 팀 협업, 코드 검토 및 디버깅에 매우 중요한 명확하고 체계적인 기록 역할을 할 수 있습니다. 

1. 구조가 핵심입니다: 제목, 본문 및 바닥글 분리

빈 줄이 커밋 제목, 본문 및 바닥글을 구분하는지 확인합니다. 이러한 구별은 명확성과 쉬운 가독성을 보장합니다.

Type (Scope): Subject (Title)

Body

Footer

2. 간결한 제목 만들기

커밋 제목은 50자 이하로 제한되어야 합니다. 이러한 간결함 덕분에 특히 더 긴 제목을 자르는 도구나 플랫폼에서 커밋 로그를 볼 때 커밋 로그가 깔끔하게 유지됩니다.

3. 대문자로 시작

제목의 첫 글자는 항상 대문자여야 합니다. 로그 전체에서 일관성을 유지하는 간단하면서도 효과적인 방법입니다.

4. 제목에 마침표 없음

제목은 간결한 문장이어야 합니다. 마침표로 끝내지 마십시오.

5. 명령하고 설명하지 마세요

당신의 주제(그리고 더 나아가 당신의 제목)는 서술이 아니라 명령으로 표현되어야 합니다. 과거 시제를 피하십시오. 예를 들어 "업데이트된 헤더" 또는 "업데이트 헤더" 대신 "업데이트 헤더"를 사용합니다.

6. 본문 텍스트를 한 줄에 72자로 제한

커밋 메시지 본문에 자세한 설명을 제공할 때 각 줄은 72자를 초과하지 않아야 합니다. 이 표준은 다양한 도구와 플랫폼에서 최적의 가독성을 보장합니다.

7. 어떻게가 아니라 무엇을 왜

커밋 메시지는 변경된 사항과 이유를 설명해야 합니다. 코드 변경은 변경 방법을 알려줍니다. 따라서 코드 자체에서 명확하지 않은 이유인 컨텍스트 제공에 메시지를 집중하십시오.

커밋 메시지 유형:

• feat: 새로운 기능 소개
• fix: 버그 수정
• build: 빌드 프로세스 또는 종속성에 대한 변경 사항
• chore: 프로덕션 코드와 관련 없는 사소한 수정
• ci: CI 구성 및 스크립트 변경
• docs: 설명서 업데이트
• style: 코드 스타일/형식 변경(프로덕션 코드 변경 없음)
• refactor: 기존 코드 리팩토링
• test: 테스트 업데이트 또는 수정
• perf: 성능 향상

커밋 메시지 예시:

Feat : Thrown 상태 체크 메서드 구현, IThrowable에 자기 자신의 게임오브젝트를 반환하는 GetObject 구현

 

결론적으로 이러한 관행을 준수하면 로그가 정리된 것처럼 보일 뿐만 아니라 개발 프로세스에 대한 의미 있는 통찰력을 전달할 수 있습니다. 주요 목표는 자신, 공동 작업자 및 코드로 작업할 미래의 개발자에게 명확성을 제공하는 것입니다. 명확하고 목적을 가지고 커밋하십시오! 🚀📝