[Git] Commit Message 작성법

Commit Message

좋은 Git Commit Message는 협업과 코드 관리에 중요한 역할을 한다. 일관성 있고 읽기 쉬운 Commit Message는 다른 개발자들이 코드 변경 이력을 이해하고 협업하기 쉽게 만든다.

권장되는 Commit Message 구조

<타입>(<범주>): <간단한 제목>

<세부 설명>

타입(Type)

커밋의 목적이나 유형을 나타낸다.

- feat: 새로운 기능 추가 (A new feature)

- fix: 버그 수정 (A bug fix)

- docs: 문서 변경 (Documentation changes)

- style: 코드 스타일 변경 (Code style changes)

- refactor: 코드 리팩토링 (Code refactoring)

- test: 테스트 코드 추가 또는 수정 (Tests)

- chore: 빌드 프로세스나 도구 관련 변경 (Build process or tool changes)

범주(Category) (선택사항)

feat 타입의 경우 어떤 기능이 추가되었는지 등을 명시

간단한 제목

- 50자 이내로 명료하게 작성한다.

- 명령문 형태로 작성하며, 첫 글자는 대문자로 시작한다.

- 마침표를 사용하지 않는다.

세부 설명(선택사항)

변경사항에 대한 자세한 내용을 작성한다.

Commit Message 예시

feat(user-auth): OAuth 로그인 기능 추가

- Google과 Facebook을 이용한 OAuth 로그인 지원 추가.
- 사용자 인증 플로우를 개선하여 더욱 원활한 경험 제공.

Commit Message Tip

커밋은 작은 단위로

- 작은 변경사항에 대한 작은 커밋을 하려고 노력합니다. 이렇게 하면 코드 변경 이력을 추적하기가 쉬워진다.

명료한 메시지

- 다른 개발자들이 커밋 메시지만으로 변경 내용을 이해할 수 있도록 명료하고 간결하게 작성한다.

명령문 사용

- 커밋 메시지는 명령문으로 작성되어야 한다.