[Git] Git Commit Message Conventions - 커밋 메시지 규칙

참고 링크 : https://gist.github.com/stephenparish/9941e89d80e2bc58a153

Git Commit Message Conventions

Git Commit Message Conventions. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

작성 계기

깃 커밋을 할 때는 나 뿐만 아니라 상대방도 알아볼 수 있을 정도로 깔끔한 커밋이 필요하다.

그렇기 때문에 많은 사람들이 사용하는 깃 커밋 규칙을 따르는 것이 좋을 것이라 생각한다.

지금 제대로 알아두고 습관화 해두면 두고두고 사용할 수 있는 규칙이 될 것 같아서 제대로 배워두고자 한다.

또한 위의 참고 링크를 번역한 많은 블로그 글이 있는데 내가 다시 작성하는 이유는 나의 공부를 위한것도 있지만

나처럼 커밋에 익숙하지 않은 사람들은 정확하게 어떻게 작성하는 게 맞는지에 대한 예시가 가장 궁금하다.

그래서 예시로 어떻게 작성하는 게 좋을지에 대한 글을 써보고자한다.

번역하여 글을 잘 정리한 글은 많기 때문에 나는 바로 사용할 수 있도록 핵심만 다루고자 한다.

커밋 메시지 구조

우선 커밋 메시지를 가장 쉽게 작성하는 방법은 아래와 같다.

git commit -m "메시지"

메시지 부분에 쌍따옴표를 제외하고 자신이 원하는 내용을 입력하면 된다.

원래 작성하던 대로 하면 feat : 기능 추가와 같은 방식으로 쓰면 된다.

근데 body와 footer가 있는 것은 몰랐다!

우선 커밋의 전체적인 구조는 아래와 같다

<type>: <subject>

<body>

<footer>

Type

type	설명	예시
feat	새로운 기능을 추가할 때 사용한다.	feat : 회원가입 기능 추가
fix	버그를 수정할 때 사용한다.	fix: 로그인 버튼이 동작하지 않던 문제 수정
docs	문서를 수정하거나 추가할 때 사용한다.	docs: README에 설치 가이드 추가
style	코드의 포맷만 수정하는 경우 (기능 변경 X)	style: 코드 줄 바꿈 및 들여쓰기 수정
refactor	코드 리팩토링 (기능 동일, 코드 구조 변경 O)	refactor: 중복 코드 제거 및 함수 모듈화
test	테스트 코드를 추가하거나 수정할 때 사용	test: 사용자 로그인 테스트 추가
chore	기타 자잘한 작업, 빌드 업무/개발 도구 설정 변경	chore: 패키지 버전 업데이트

Subject

명령형, 현재형을 사용하면 안된다. => 구문 형식
첫 글자는 대문자로 작성해선 안된다. (한글 해당 X)
끝에 마침표가 없어야 한다.

Body

사실 이 글을 작성한 이유.. Body부분은 작성해본 적이 없다.

물론 선택사항이긴 하다.

일단 Subject를 작성하고 나면 Body와 한 줄의 빈 라인(Blank Line)이 필요하다.

명령형을 사용하고, 현재 시제를 사용한다.
변경에 대한 동기를 포함하고, 이전 동작과의 차이를 명시한다.

예시 형식은 아래와 같다.

feat: 회원가입 기능 추가

사용자가 회원가입할 수 있는 기능을 추가합니다:
- 사용자 이름, 이메일, 비밀번호 입력 필드를 제공
- 입력된 정보에 대한 유효성 검사를 수행
- 서버로 회원가입 요청을 전송하고 응답을 처리
- 회원가입 완료 후 환영 메시지를 표시

Footer

중요한 변경 사항을 작성하는 곳이다.

아마 이슈가 없거나 주요 변경 사항이 없다면 작성을 제외해도 되는 선택 사항이다.

간단하게 이슈 번호를 작성해도 되는 것 같다.

Closes #351

결론

결론적으로 자주 쓰게 될 커밋의 Type과 Subject 작성 방법은 외워두고 커밋에 담을 내용이 많다면 Body 칸을 활용하여 커밋 메시지를 작성하면 될 것 같다!

'📍 Front-End > Git&Github' 카테고리의 다른 글

[Git] 여러 개의 깃 커밋 한번에 수정하기 (2)	2024.10.31
[Git] Merge 개념 (Merge, Fast-Forward, Three-Way, Rebase / Squash & Merge) (4)	2024.09.23

Sun`s diary

[Git] Git Commit Message Conventions - 커밋 메시지 규칙

작성 계기

커밋 메시지 구조

Type

Subject

Body

Footer

결론

'📍 Front-End > Git&Github' 카테고리의 다른 글

티스토리툴바

[Git] Git Commit Message Conventions - 커밋 메시지 규칙

작성 계기

커밋 메시지 구조

Type

Subject

Body

Footer

결론

'📍 Front-End > Git&Github' 카테고리의 다른 글

관련글

티스토리툴바