작성일:

Git 시맨틱 커밋 메시지 가이드

시맨틱 커밋 메시지란?

시맨틱 커밋 메시지는 커밋의 목적과 의도를 명확하게 전달하기 위한 규칙입니다. 이 규칙을 따르면 프로젝트의 히스토리를 쉽게 이해하고 자동화된 도구를 활용할 수 있습니다.

기본 구조

시맨틱 커밋 메시지의 기본 구조는 다음과 같습니다:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

주요 타입

커밋 메시지는 다음 타입 중 하나로 시작해야 합니다:

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • docs: 문서 변경
  • style: 코드 포맷팅, 세미콜론 누락 등 (코드 변경 없음)
  • refactor: 코드 리팩토링
  • test: 테스트 코드 추가 또는 수정
  • chore: 빌드 프로세스 또는 보조 도구 변경

모범 사례

  1. 제목은 50자 이내로 제한합니다.
  2. 제목의 첫 글자만 대문자로 씁니다.
  3. 제목 끝에 마침표를 넣지 않습니다.
  4. 제목과 본문 사이에 빈 줄을 넣습니다.
  5. 본문은 72자마다 줄바꿈합니다.
  6. 명령형 현재 시제를 사용합니다 (예: “변경”, “수정함” 대신 “변경하다”).

예시

좋은 커밋 메시지 예시:

feat: 모자 흔들기 기능 추가

사용자가 모자를 흔들 수 있는 새로운 기능을 추가했습니다.
이 기능은 사용자 경험을 향상시키고 앱의 재미 요소를 증가시킵니다.

Closes #123

도구 활용

커밋 메시지 템플릿을 사용하면 일관된 형식을 유지하는 데 도움이 됩니다. Git 설정에 다음과 같이 템플릿을 추가할 수 있습니다:

git config --global commit.template path/to/commit-template.txt

결론

시맨틱 커밋 메시지를 사용하면 프로젝트의 변경 사항을 명확하게 추적하고 관리할 수 있습니다. 이는 협업과 유지보수를 더욱 효율적으로 만들어 줍니다. 일관된 규칙을 따르는 것이 중요하며, 팀원들과 합의하에 프로젝트에 가장 적합한 규칙을 정하고 따르는 것이 좋습니다.

댓글남기기