[Git] 협업을 위한 Commit Convention (Conventional Commits)

git

커밋 컨벤션은 Git을 사용해서 프로젝트를 관리할 때, 커밋 메시지를 작성하는 규칙으로 팀 또는 회사마다 코딩 컨벤션(coding convention)이 있듯이 커밋 컨벤션도 협업을 위해서 필수적인 규칙이다.

이 포스팅에서 설명하는 커밋 컨벤션은 'Conventional Commits' 에 대한 설명이다.

 

먼저, Conventional Commits 커밋 컨벤션은 AngularJS 커밋 컨벤션(AngularJS 개발팀에서 사용하는 커밋 컨벤션으로, 각 커밋 메시지에 태그를 붙여 작성하는 것이 특징)을 기반으로 만들어 졌으며, 커밋 메시지를 보다 자세하게 작성하는 것이 특징이며, 가장 널리 사용되는 커밋 컨벤션 중 하나이다.

 

Conventional Commits에서 사용되는 접두어들에 대해 예시와 함께 설명해보면 아래와 같다.

 

• feat: 새로운 기능 추가
  • 예시: [feat] 로그인 기능 추가
• fix: 버그 수정
  • 예시: [fix] 사용자 로그인이 안되는 버그 수정
• docs: 문서 변경
  • 예시: [docs] API 문서 업데이트
• style: 코드 포맷팅, 세미콜론 누락 등 코드 스타일 변경
  • 예시: [style] 코드 인덴트 수정
• refactor: 코드 리팩토링
  • 예시: [refactor] 중복 코드 제거
• test: 테스트 코드 작성 또는 수정
  • 예시: [test] 로그인 테스트 코드 추가
• chore: 빌드 툴 수정, 패키지 매니저 수정 등 빌드 프로세스나 테스트 설정 변경
  • 예시: [chore] 프로젝트 의존성 업데이트

팀마다 또는 회사마다 사용하는 커밋 컨벤션과 접두어의 유형 등이 있을 수 있다.

하지만 커밋 메시지의 일관성과 가독성을 유지하기 위해선, 프로젝트에서 사용하는 컨벤션을 지켜서 작성하는 것이 협업에 더 도움이 된다!