2024. 02. 04 git commit 메시지 작성하는 방법

 

Git Commit 메시지 작성 기본 원칙

 

명확하고 간결하게

commit 메시지는 간결하면서도 변경 사항을 명확하게 설명해야 한다.

 

제목과 본문 분리

일반적으로 메시지는 제목과 본문 두 부분으로 나뉘고 제목과 본문은 빈 줄로 구분한다.

 

제목 형식 유지

제목은 대문자로 시작하며, 50자 이내로 제한하고, 끝에 마침표를 붙이지 않아야 한다.

명령어 : git commit -m "제목" 

 

 

본문 작성

본문에서는 변경 사항에 대한 상세한 설명, 변경의 이유, 추가적인 정보를 제공한다.
본문은 한 줄에 72자 이내로 제한하는 것이 좋다.

명령어: git commit 

엔터 이후 본문 작성

 

명령조 사용

제목은 명령조로 작성하는게 좋다.
 ex) "Fix bug" 또는 "Add feature"

 

---

Git Commit 메시지 작성할 때 규칙(관례)

 

기능 추가(Feature)

Add: 새로운 기능이나 파일을 추가할 때 사용합니다.
ex) Add: context api for stage management

 

 

버그 수정(Bug Fix):

Fix: 버그나 오류를 수정했을 때 사용합니다. 예: Fix login issue

 

문서 작업(Documentation):

Docs: 문서를 추가하거나 업데이트할 때 사용합니다. 예: Docs update README

 

스타일 변경(Style):

Style: 코드의 기능에 영향을 주지 않고, 형식(공백, 포맷팅, 누락된 세미콜론 등)을 변경할 때 사용합니다.
ex) Style fix tab indentation

 

코드 리팩토링(Refactoring):

Refactor: 프로덕션 코드를 재구성하지만, 기능을 변경하지 않을 때 사용합니다. 예: Refactor user service class

 

성능 개선(Performance):

Perf: 코드를 최적화하거나 성능을 향상시킬 때 사용합니다. 예: Perf improve query speed

 

테스트 추가 및 수정(Testing):

Test: 새로운 테스트를 추가하거나 기존 테스트를 수정할 때 사용합니다. 예: Test add new unit tests for user controller

 

코드나 파일 삭제(Removal):

Remove: 코드나 파일을 삭제할 때 사용합니다. 예: Remove unused user service methods

 

애플리케이션 또는 종속성 업그레이드(Upgrade):

Upgrade: 애플리케이션의 라이브러리나 종속성을 업그레이드할 때 사용합니다. 예: Upgrade to React 17

 

기타 변경사항(Chore):

Chore: 빌드 태스크, 패키지 매니저 설정 등과 같이 소스 코드나 테스트 파일에 속하지 않는 기타 변경 사항에 사용합니다. 예: Chore update build script