협업을 위한 Git commit message 작성법 (+ 템플릿 적용하기)

 

 

 

---

 

깃 커밋 메시지는 어떻게 작성해야 좋을까?

 

 

---

 

 

 

 

commit 형식

 

--

type: 제목

body(선택)

footer(선택)

fix: 로그인 오류 수정

- 잘못된 세션 처리로 인한 로그인 실패 버그 수정
- 로그인 성공 후 리다이렉트 처리 개선

Fixes #123

 

type (제목)

현재 커밋한 내용을 간략하고 보기 편하게 요약해서 작성하는 것으로

현재 커밋한 내용의 카테고리를 type으로 작성하고, 제목을 작성한다.

 

body

type파트의 제목에 작성한 내용에 대해 더욱 이해하기 좋게 상세한 내용을 작성하며,

만약 type파트에서 충분히 내용을 표현할 수 있다면 생략이 가능하다.

 

footer

해당 커밋은 어떤 이슈로 인해 작성했는지 참조 정보들을 추가하는 용도로

위 예시를 설명하면 #123 이슈에 대해 커밋한 내용이다.

이 또한 생략이 가능하다.

--

 

 

 

 

일반적인 commit message 규칙

 

--

• 제목(type), 본문(body), 꼬리말(footer)은 중간에 "빈 행"을 두어 구분한다.
• 제목의 첫 글자는 대문자로 작성한다.
• 제목 끝에는 (.)마침표를 작성하지 않는다.
• 제목은 50자를 넘지 않도록 한다.
• 본문은 각 행마다 72자를 넘지 않도록 한다.
• 본문에 "어떻게"보다는 "무엇을?", "왜?"을 설명한다.

--

 

 

 

 

일반적인 Type 종류

 

--

--

 

 

 

 

commit 방법

 

--

git commit -m "fix: 로그인 오류 수정" -m "

- 잘못된 세션 처리로 인한 로그인 실패 버그 수정
- 로그인 성공 후 리다이렉트 처리 개선

Fixes #123"

// 또는
git commit -m "fix: 로그인 오류 수정

- 잘못된 세션 처리로 인한 로그인 실패 버그 수정
- 로그인 성공 후 리다이렉트 처리 개선

Fixes #123"

fix: 로그인 오류 수정

- 잘못된 세션 처리로 인한 로그인 실패 버그 수정
- 로그인 성공 후 리다이렉트 처리 개선

Fixes #123

 

첫 번째 -m "메시지"는 제목으로 들어가고

다음 -m "메시지"는 내용으로 들어간다.

 

 

위 방법처럼 바로 커밋 메시지를 작성하는 것 말고도

vim(텍스트 에디터)에 접근해서 작성하는 방법도 있다.

--

 

 

 

 

vim에 commit message 형식(템플릿) 적용하기

 

--

commit message용 txt파일 생성하기

$ touch ~/.message.txt

message.txt 파일은 사용자의 홈 폴더에 생성된다.
Linux/Mac  :  /home/<사용자이름> 또는 /Users/<사용자이름>
windows  :  C:\Users\<사용자이름>

 

 

vim으로 해당 message.txt파일 접근하기

$ vim ~/.message.txt

 

 

vim에서 템플릿 형식 작성 후 저장

### Title
# 커밋 타입: 작업내용

### Body
# 무엇을, 왜, 어떻게 했는지 + 한 줄에 최대 72 글자까지만 입력하기

### Footer
# 어떠한 이슈로 커밋을 했는지

# -----------------------------
# [Type]
# feat : 기능 추가
# fix : 버그 수정
# design : CSS 등 사용자 UI 디자인 변경
# refactor : 코드 리팩토링 (기능 변화 없이 코드 개선)
# style : 코드 스타일 변경
# docs : 문서 추가, 수정, 삭제
# test : 테스트 코드 추가 및 수정
# chore : 기타 변경사항 (빌드 설정, 패키지 관리 등)
# rename : 파일 & 폴더명을 수정 및 이동만 수행
# remove : 파일 삭제하는 작업만 수행
# -----------------------------

 

vim 간단 명령어

 

작성 후 :wq로 저장 후 나가기

 

 

git 글로벌로 설정하기

$ git config --global commit.template ~/.message.txt

이제 어떤 프로젝트를 사용하든 해당 git 사용자로 관리하면
해당 템플릿이 나오게 된다.

 

 

+

해당 설정 제거하기

git config --global --unset commit.template

--