GitHub 커밋 메시지 Convention

GitHub 커밋 메시지 작성 규칙

1. 커밋 메시지의 목적
   커밋 메시지는 코드 변경 사항을 명확하게 기록하여 팀원들이 쉽게 이해할 수 있도록 하는 것이 중요하다. 좋은 커밋 메시지는 코드의 변경 내용과 이유를 쉽게 파악할 수 있게 해준다. 주로 다음과 같은 목적으로 사용된다:

   • 변경 사항의 명확한 설명
   • 변경 이유 또는 의도 전달
   • 코드 기록의 일관성 유지

2. 커밋 메시지의 형식
   보통 커밋 메시지는 세 가지 부분으로 구성된다:

   • 제목(Subject):

     • 50자 이내로 간결하게 작성
     • 대문자로 시작하며 마침표는 생략
     • 변경 사항을 명확하게 설명하는 동사 형태 사용 (예: "Add", "Fix", "Refactor")

   • 본문(Body):

     • 선택적이며 더 자세한 변경 사항을 기록
     • '무엇'을 했는지보다 '왜' 변경했는지를 설명하는 데 중점

   • 바닥글(Footer):

     • 이슈 트래킹 번호를 포함할 수 있음 (예: #123)

3. 커밋 메시지 예시

   feat: Add user authentication feature
   
   Implemented user authentication using JWT. This includes login, signup, and password encryption functionalities.
   
   Closes #101

   • feat:는 새로운 기능 추가를 의미한다.
   • Closes #101는 해당 커밋이 이슈 번호 101번을 해결했음을 나타낸다.

4. 일반적인 커밋 태그
   GitHub에서는 커밋 메시지의 제목에 특정 태그를 사용하여 커밋의 성격을 명확하게 할 수 있다. 다음은 일반적으로 사용되는 커밋 태그들이다:

   • feat: 새로운 기능 추가
   • fix: 버그 수정
   • refactor: 코드 리팩토링
   • style: 코드 스타일 변경 (공백, 줄바꿈 등)
   • test: 테스트 추가 또는 수정
   • docs: 문서 수정
   • chore: 빌드 작업이나 패키지 관리 같은 자잘한 작업