본문 바로가기
CS

[git] 좋은 Commit Message 작성하는 방법

by eun2ng 2024. 12. 14.

이 글을 보시는 분들은 git을 사용할 때 커밋 메시지를 잘 작성하시나요??

저는 부끄럽게도 학부 시절 git을 통해 협업을 할 때, 버전 관리의 중요성을 몰라서 커밋 메시지를 엉망으로 작성한 경험이 있습니다...😓

여러 사람과 팀을 이뤄 협업을 할 때나, 오픈 소스에 기여하게 될 때에는 커밋 메시지를 잘 작성하는 것이 정말 중요합니다!

이번 게시물에서는 커밋 메시지의 중요성좋은 커밋 메시지 작성하는 방법을 알아보겠습니다.

 

✅ 커밋 메시지를 잘 작성해야하는 이유

1. 변경 사항의 명확한 기록

좋은 커밋 메시지는 코드가 왜, 무엇을, 어떻게 변경했는지를 명확하게 설명합니다.

이것은 나중에 프로젝트의 변경 내역을 추적하거나 특정 기능이나 버그를 찾아야 할 때 유용합니다.

 

2. 팀원 간의 효과적인 의사소통

협업 중에 팀원이 서로의 작업 내용을 빠르게 이해할 수 있도록 돕습니다.

"무엇을 했는지"를 한눈에 알 수 있다면 불필요한 질문과 시간이 줄어듭니다.

 

3. 장기적인 프로젝트 관리

시간이 지나 프로젝트의 규모가 커지고 팀원이 바뀌더라도, 명확한 커밋 메시지는 프로젝트의 변경 히스토리를 이해하는 데 큰 도움이 됩니다.

 

이 이외에도 코드리뷰, Jira 같은 작업 툴과의 통합을 할 때에도 유용합니다.

 

✅ Commit Message 구조

{type}: {description} 작업 단위 축약 제목
{body} 작업 상세 기술 (생략 가능)
{footer} 부가정보(생략 가능)

ex)

docs: Update README.md

add Intro to README.md

BREAKING CHANGE: Drop email sign up support

 

커밋메시지의 구조는 제목, 내용, 부가정보 세 부분으로 나눌 수 있습니다. 

 

제목은 커밋의 type과 작업 단위를 축약해서 작성합니다. 제목을 작성하고 한 행을 띄어서 내용을 작성할 수 있습니다. 

내용은 제목에서 표현할 수 없는 상세한 내용을 적습니다. 제목에서 충분히 표현할 수 있다면 생략 가능합니다.

breaking change가 있다면 제목의 type 뒤에 !를 작성해야합니다.

 

✅ 커밋 메시지 쓰는 법

1. commit의 제목은  commit을 설명하는 문장형이 아닌 구나 절의 형태로 작성

ex) Add test.md   /  Resolve issue with login page

 

2. 제목에서 첫 글자는 대문자 사용

ex) update index.html ❌

      Update index.html ⭕

 

3. prefix 꼭 달기

• feat

기능 개발 관련

•  fix

오류 개선 혹은 버그 패치

•  docs

문서화 작업

•  test

test 관련

•  config

환경설정 관련

•  build

빌드 작업 관련

•  ci

Continuous Integration 관련

•  chore

패키지 매니저, 스크립트 등

•  style

코드 포맷팅 관련

 

4. 제목 행을 50자로 제한

 

5.  제목 행 끝에 마침표 넣지 않기

 

6. 팀에서 정한 commit 규칙을 따르기

 

 

협업 시 팀과의 원활한 의사소통을 위해서도, 버전 관리를 위해서도 꼭 필요한 커밋 메시지 잘 쓰는 법!미리 알아두고 연습해서 커밋도 잘하는 개발자로 성장합시다!😝저는 오늘도 다짐해봅니다. 1일 1커밋 도전!!!!!!!!!