본문 바로가기
CI.CD/GIT

[GIT] 프로페셔널한 커밋 메시지 작성 가이드

반응형

이번 포스팅에서는 [생산성 향상 & 팁] 파트의 세부 주제인 프로페셔널한 커밋 메시지 작성 가이드에 대하여 상세히 알아보겠습니다.

1. 커밋 메시지는 문서다

자신이 작성한 코드를 6개월 뒤에 다시 보거나, 다른 동료가 인수인계를 받을 때 가장 먼저 들여다보는 것이 바로 커밋 메시지 이력입니다. 코드의 '변경 내용(How)'은 소스 코드의 diff를 통해 알 수 있지만, '변경 이유(Why)'는 오직 커밋 메시지를 통해서만 파악할 수 있습니다.

2. Conventional Commits 규약

오픈소스 커뮤니티를 중심으로 정립된 규약으로, 머리말(Prefix)을 달아 커밋의 성격을 직관적으로 분류하는 방식입니다. 자동화된 릴리스 노트 작성 도구 등과 연동하기에도 매우 유리합니다.

  • feat: 어플리케이션에 새로운 기능을 추가한 경우
  • fix: 기존 기능의 버그를 수정한 경우
  • docs: README.md 등 문서 항목만 수정한 경우
  • style: 코드 포맷팅, 세미콜론 추가 등 비즈니스 로직에 변경이 없는 경우
  • refactor: 코드의 구조와 성능을 개선한 리팩토링의 경우
  • test: 테스트 코드를 추가하거나 수정한 경우
  • chore: 빌드 시스템 구성, 패키지 매니저(npm, yarn) 설정 수정 등
# 권장하는 커밋 메시지 작성 예시
feat: 사용자 프로필 이미지 업로드 기능 추가

- AWS S3 스토리지 연동 로직 포함
- 업로드 전 이미지 리사이징 처리로 최적화 수행
- 관련 이슈 티켓: #123

지금까지 프로페셔널한 커밋 메시지 작성 가이드의 개념과 구체적인 활용 방안에 대해 살펴보았습니다. 이어지는 다음 포스팅에서 관련 심화 주제를 지속적으로 다루어보겠습니다.

반응형