Git commit 메시지 작성 가이드

커밋 메시지 작성가이드를 우리 챗GPT를 통해 생성해 봤다. 쓸만한가?

간결하면서도 실용적인 Git 커밋 메시지 가이드를 만들어보겠습니다. 이 가이드는 이해하기 쉽고, 일관성을 유지하면서도 실용성을 강조합니다.

---

나만의 Git 커밋 메시지 가이드

커밋 메시지 구조

1. 제목 (Summary)
2. 본문 (Body)
3. 이슈 참조 (References)

1. 제목 (Summary)

• 형식: <타입>: <요약>
• 예시: feat: 사용자 로그인 기능 추가
• 규칙:
  • 50자 이내로 간결하게 작성합니다.
  • 첫 글자는 대문자로 작성합니다.
  • 명령형으로 작성합니다 (예: Add, Fix, Update).
  • 끝에 마침표를 쓰지 않습니다.
  • 사용 가능한 타입:
    • feat: 새로운 기능 추가
    • fix: 버그 수정
    • docs: 문서 변경
    • style: 코드 포맷 변경 (기능에 영향 없음)
    • refactor: 코드 리팩토링 (기능 변화 없음)
    • perf: 성능 개선
    • test: 테스트 추가 또는 수정
    • chore: 기타 변경사항 (빌드 수정, 도구 설정 등)
    • remove: 파일 또는 기능 제거
    • add: 파일 또는 기능 추가

2. 본문 (Body)

• 형식: 빈 줄로 시작하여 요약과 본문을 구분합니다.

• 예시:

  feat: 사용자 로그인 기능 추가
  
  사용자 로그인 기능을 추가하여 사용자가 계정으로 로그인할 수 있도록 구현했습니다. 로그인 시 사용자의 아이디와 비밀번호를 검증하는 로직을 포함했습니다.

• 규칙:

  • 72자 내외로 줄을 바꿔 작성합니다.
  • 변경 이유와 무엇이 변경되었는지 설명합니다.
  • 필수 사항은 아니며, 간단한 커밋에는 생략할 수 있습니다.
  • 명령형으로 작성합니다.

3. 이슈 참조 (References)

• 형식: 본문 끝에 빈 줄을 추가하고 이슈 번호를 참조합니다.
• 예시: Resolves: #123
• 규칙:
  • 관련 이슈 번호를 참조하여 추적 가능성을 높입니다.
  • 여러 이슈를 참조할 경우 각각의 이슈 번호를 나열합니다 (예: Resolves: #123, #456).

예시

1. 간단한 커밋 메시지:

    fix: 로그인 오류 수정

2. 상세한 커밋 메시지:

    feat: 사용자 로그인 기능 추가
   
    사용자 로그인 기능을 추가하여 사용자가 계정으로 로그인할 수 있도록 구현했습니다. 로그인 시 사용자의 아이디와 비밀번호를 검증하는 로직을 포함했습니다.
   
    Resolves: #45

3. 불릿 포인트 사용:

    refactor: 코드 구조 개선
   
    - 로그인 로직을 별도의 모듈로 분리
    - 유틸리티 함수 추가
    - 불필요한 주석 제거
   
    Resolves: #78

요약

• 제목: 50자 이내, 대문자로 시작, 명령형, 마침표 없음
• 본문: 72자 내외 줄 바꿈, 명령형, 빈 줄로 요약과 구분
• 이슈 참조: 관련 이슈 번호 참조, 본문 끝에 위치

이 가이드는 간결하면서도 일관된 커밋 메시지를 작성하는 데 도움이 될 것입니다. 팀 내에서도 쉽게 적용할 수 있습니다.