[git] commit 메시지 규칙

Git 커밋 메시지를 작성할 때는 일관성과 가독성을 유지하는 것이 중요합니다. 일반적으로 사용되는 Git 커밋 메시지 작성 규칙은 다음과 같습니다:

 

1. 메시지 구조

 

커밋 메시지는 세 부분으로 나눌 수 있습니다:

• 제목 (Title): 한 줄로 요약 (50자 이내 권장)

• 본문 (Body): 변경 사항에 대한 상세 설명 (선택 사항, 72자 줄바꿈 권장)

• 푸터 (Footer): 관련된 이슈 번호나 참고 정보 (선택 사항)

 

예시:

 

<타입>: <짧고 명확한 제목>

 

<본문: 변경 사항의 이유, 배경, 자세한 설명>

<필요시 푸터: 이슈 참조 또는 부가 정보>

 

2. 제목 작성 규칙

• 명령문 형태로 작성하세요. (예: “Add”, “Fix”, “Update” 등)

• 나쁜 예: “Added new feature”

• 좋은 예: “Add new feature”

• 첫 글자는 대문자로 시작하세요.

• 마침표는 생략하세요.

• 50자를 넘지 않도록 간결하게 작성하세요.

 

3. 타입 사용 (Type)

 

커밋 메시지에 타입을 명시하면 커밋 목적이 더 명확해집니다. 아래는 일반적으로 사용되는 타입들입니다:

• feat: 새로운 기능 추가

• fix: 버그 수정

• docs: 문서 수정

• style: 코드 스타일 변경 (기능에 영향 없는 변경)

• refactor: 코드 리팩토링 (기능 변경 없음)

• test: 테스트 추가 또는 수정

• chore: 빌드 프로세스나 설정 관련 작업

 

예:

 

feat: Add user authentication feature

fix: Correct typo in login error message

docs: Update README with setup instructions

 

4. 본문 작성 규칙 (선택 사항)

• 본문은 ‘무엇을’, ‘왜’ 변경했는지 설명합니다.

• 간결하지만 필요한 정보를 충분히 담으세요.

• 한 줄에 72자를 넘지 않도록 작성하세요.

 

예:

 

fix: Resolve crash on login button click

 

The app was crashing when the login button was clicked due to 

a null pointer exception. Added a null check to prevent this issue.

 

5. 푸터 작성 규칙 (선택 사항)

• 관련된 이슈 번호를 언급하세요.

• 이슈 참조 형식: Refs #123 또는 Fixes #123

• Fixes를 사용하면 해당 커밋으로 이슈가 자동으로 닫힙니다.

 

예:

 

fix: Handle API timeout error gracefully

 

Improved error handling for API timeouts by adding a retry 

mechanism. This prevents the app from freezing during long requests.

 

Fixes #456

 

6. 일관성 유지

• 팀에서 사용하는 규칙이 있다면 반드시 따르세요.

• 여러 사람이 협업할 때는 일관성 있는 메시지 스타일이 가독성을 높입니다.