Git "커밋 메시지 컨벤션(Commit Message Convention)" 사용해보자

juny_0429·2023년 6월 20일
0

커밋 메시지 컨벤션은 개발자들 간의 일관성, 협업 효율성, 코드 이력의 가독성을 향상시키는 중요한 요소입니다.
프로젝트에 맞는 컨벤션을 정의하고 사용함으로써, 개발과 관리 과정에서의 혼란을 최소화하고 효율성을 높일 수 있습니다.

커밋 메시지 컨벤션(Commit Message Convention)

프로젝트에서 일관성 있고 이해하기 쉬운 커밋 메시지를 작성하기 위해 사용되는 규칙

커밋 메시지 컨벤션을 사용하면 팀원들 간의 커밋을 쉽게 파악할 수 있고,
변경 내용을 추적하고 관리하기 쉬워집니다.



커밋 메시지 컨벤션을 사용해야 하는 이유

  • 가독성과 이해성 향상
    일관된 커밋 메시지 형식을 사용하면 다른 개발자들이 변경 내용을 빠르게 이해할 수 있습니다.
    커밋 메시지를 읽는 사람들은 각 커밋이 어떤 작업을 수행했는지 파악할 수 있으며,
    필요한 정보를 쉽게 찾을 수 있습니다.

  • 변경 이력 추적
    커밋 메시지 컨벤션을 사용하면 변경 이력을 추적하고 관리하기 쉬워집니다.
    각 커밋이 어떤 유형의 변경을 반영하는지 명확하게 구분할 수 있으며,
    필요한 경우 특정 타입의 커밋만 필터링하여 확인할 수 있습니다.

  • 협업의 원활함
    팀이나 다른 개발자들과 협업할 때, 일관된 커밋 메시지 컨벤션을 사용하면 의사소통이 원활해집니다.
    모두가 동일한 형식과 규칙을 이해하고 사용함으로써,
    변경 사항에 대한 이해와 협력이 강화됩니다.

  • 문제 해결과 유지 보수 용이성
    커밋 메시지 컨벤션을 사용하면 코드의 버그 수정, 기능 개선, 리팩토링 등의 작업을 명확하게 기록할 수 있습니다.
    이를 통해 문제 발생 시 커밋 로그를 참조하여 문제 해결 과정을 추적하고,
    코드의 유지 보수를 효율적으로 진행할 수 있습니다.



Conventional Commit 구조

<type>: <Subject> -> 제목  

body(생략 가능) -> 본문  

footer(생략 가능) -> 꼬리말

여기서 <type> 은 커밋의 성격이나 유형을 나타내는 것이고,
<Subject> 는 커밋에 대한 간단한 설명입니다.

1. Commit Type

반적으로 사용되는 커밋 타입은 다음과 같습니다.
프로젝트의 특정 요구 사항이나 팀의 개발 프로세스에 따라 추가적인 커밋 타입을 정의할 수도 있습니다.

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • docs: 문서 변경
  • style: 코드 포맷팅, 세미콜론 누락 등 스타일 변경
  • refactor: 코드 리팩토링
  • test: 테스트 코드 추가 또는 수정
  • chore: 빌드 스크립트, 패키지 매니저 설정 등의 변경
예시)
feat: 사용자 등록 기능 추가
fix: 로그인 버그 수정

2. Subject Rule

  • 일반적으로 50자를 넘지 않도록 작성
  • 마침표 및 특수기호 사용 X
  • 첫글자 대문자, 현재 시제로 명령문을 사용
  • 간결하게 작성

3. Body Rule(생략가능)

  • 가독성을 위해 각 줄은 72자를 넘지 않도록 작성
  • 필요에 따라 여러 줄로 작성
  • 본문과 제목 사이에는 한줄을 비워 구분
  • 커밋에 대한 상세한 변경 사항, 이유, 방법 등을 기록

  • 커밋과 관련된 메타 정보를 기록
  • 주로 이슈 번호, 참조 링크, 특정 이벤트와 연결된 정보

0개의 댓글