Git 커밋 메시지 간결하게 작성하는 방법 정리

커밋 메시지는 프로젝트의 히스토리를 명확하게 하고,

팀 협업을 원활하게 해 주는데요.

 

저는 소규모 개인프로젝트를 하기에,

큰 단위로 작업하고 커밋을 정리해 올리기보다는,

작은 작업단위로 자주 올리는 것을 선호합니다.

그래서 커밋 메시지도 많이 고민해서 쓰는 방법보다는,

간결하게 작성하는 법을 익혀,

자주 커밋하는 방식을 취하는데요.

 

오늘은 간결하게 Git 커밋 메시지 작성하는 방법에 대해 알아보겠습니다.

 

1. 커밋 메시지 형식

커밋 메시지를 작성하는 형식은 여러 가지가 있지만,

아래의 형식이 주로 많이 사용됩니다.

 

<타입>(<범위>): <제목>

 

위에서 사용된 요소들은 다음과 같은 의미를 가집니다.

• 타입: 커밋의 종류 (예: feat, fix, docs 등)
• 범위: 변경한 파일이나 변경사항의 범위(선택사항)
• 제목: 변경사항을 간단히 요약

위의 형식을 사용해서 작성한 커밋 메시지는 다음과 같습니다.

 

fix(login): Prevent crash on login with empty password

 

 

범위를 한 단어나 짧은 단어로, 특정하기 어려울 때는 빼고 적어도 됩니다.

 

2. 커밋 타입(목적)

커밋타입을 빨리 정하고, 간결한 제목에 집중하기 위해서,

아래 상위 4개의 타입들 정도는,

머릿속에 넣어놓고 사용하면 좋습니다.

• feat: 새로운 기능 추가 ex) feat: add user authentication
• fix: 버그 수정 ex) fix: resolve login issue
• chore: Updating Dependencies, buildScript 같은 작은 일들을 가리킵니다.
• refactor: 코드 리팩토링 (기능 변경 없음)
• docs: 문서 수정
• style: 코드 포맷팅 등
• test: 테스트 추가 또는 수정
• build: 빌드 시스템 또는 외부 종속성에 영향이 있는 변경
• ci: CI 설정 관련 변경
• revert: 이전 커밋 되돌리기

 

 

3.  간결한 커밋 메시지 작성방법

이제 주목할 것은 간결한 메시지를 만드는 것인데요.

아래의 방법들을 참고하면 도움이 됩니다.

 

3-1. 동사로 시작하기

핵심 내용을 전달할 수 있는 동사로 커밋 문장을 시작하는 것이 좋습니다.

문법은 고민하지 말고, 뭘 했는지 그것에 대한 동사를 찾아서 작성합니다.

 

예를 들면 다음과 같이 Replace로 시작되는 동사로 작성하는 것입니다.

• refactor(layout): Replace RelativeLayout with ConstraintLayout

아래와 같이, 각 타입에 따라 사용하는 동사들이 있으니 이를 미리 알아두면 도움이 됩니다.

 

주요 타입
feat	add, repleace, implement, create, enable
fix	Resolve, Correct, Improve, Prevent, patch, address, eliminate, repair, adjust, clear
chore	add, update(update dependencies), maintain, configure, remove, install, backup
refactor	improve, enhance, simplify, rename, clean, modularize(모듈화), enhance

 

 

동사를 사용할 때,

위와 같이 현재형으로 통일해서 사용합니다.

 

3-2. 무엇을 했는가에 초점

어떻게 바뀌었는가 보다, 무엇을 바꾸었는지를 중심에 두고 커밋메시지를 작성하는 것이 좋습니다.

다양한 커밋메시지를 보면서 감을 익혀보겠습니다.

• feat(user): Add user profile page
• refactor(image): Improve image loading time on homepage
• fix(api): Resolve error in user authentication process
• docs(README): Update installation instructions
• refactor(database): Optimize database schema
• style(button): Improve button styles
• test(auth): Add unit tests for login functionality
• chore(dependencies): Upgrade dependencies to latest versions

 

3-3. 마침표 없이 끝낸다.

위의 커밋메시지들에서 본 것처럼,

문장의 마지막에 마침표를 쓰지 않습니다.

 

간결한 커밋메시지 작성을 위해,

문법적인 장식을 최소화하는 건데요.

 

커밋요소에 대해서는 명확하고 구체적으로 나타내되,

이런 장식적인 요소는 과감하게 생략하는 것이 좋습니다.

 

4. 정리

간결한 Git 커밋메시지 작성 방법에 대해서 정리해 보았는데요.

팀마다, 작성하는 사람마다, 혹은 프로젝트 성격마다,

적합한 방법은 달라질 수 있으므로,

위의 사항들을 참고하여,

프로젝트에 맞는 방식으로 바꿔서 사용하면 됩니다.