[github] gitMessage, git commit 규칙 만들기

개발자들이 본인의 소스를 공개하고 여러 개발자들이 같이 개발할 수 있게 지원해주는 것, git이다.

뭐 안 쓰는 사람이나, SVN을 쓰는 사람이나 여러 개발자들이 있겠지만 아마 대부분은 쓰는 것 같다

(채용 시 git을 필수로 요구하는 회사도 있다)

 

git의 사용 이유 중에는 같은 프로젝트를 여러 개발자들이 함께 진행할 때 장점이 있는데 

내가 개발한 소스를 반영할 때 내가 개발한 부분이 무엇이고 왜 했는지에 대한 설명을 써주면 

다른 같이 개발하는 개발자가 이해하기 용이하다.

 

기존까진 commit 시에 

git commit -m "커밋메세지"

이런 식으로 메시지를 관리해왔다. 

하지만 같이 일하는 사람끼리 이 커밋 메시지의 규칙을 만든다면 

좀 더 커밋을 이해하기 용이하리라

 

그 규칙을 매번 기억하고 작성하기엔 어려움이 있다.

따라서 찾아보니 그 커밋 메세지의 규칙을 도와주는 것이 있더라.

 

바로 

. gitmessage.txt

파일이다.

 

이는 git 커밋 메시지를 남길 때 규칙에 맞게 남길 수 있도록 프레임을 제공해준다.

이 글을 쓰는 나도 다른 블로그와 커뮤니티를 통해 공부하고 적용을 해보았다. 

참조 블로그 : https://youngjinmo.github.io/2020/03/gitmessage/

커밋 메세지 더 잘 작성하기 (A.k.a. Gitmessage)

해당 블로그에 보면 규칙을 매우 잘 정리해두었다.

아마 현업에서도 비슷하게 쓰지 않을까 싶다. 

 

사용법을 소개하겠다. 

1. gitMessage 파일 생성 

일단 파일을 하나 만든다.

. gitmessage.txt 

(폴더 경로를 잘 기억해두어야 한다)

 

2. 사용할 gitMessage 규칙 만들기 

해당 파일에 본인이 하고자 하는 규칙을 만든다. 

해당 파일은 커밋 시에 vi를 사용하기 때문에 사용 방법을 숙지해두는 게 좋다. 

나는 일단 위 참조한 블로그의 규칙을 따와 쓰면서 조금씩 커스터마이징 해가려고 한다. 

# 제목은 최대 50글자까지 아래에 작성: ex) <feat>: Add OAuth2

# 본문은 아래에 작성

# 꼬릿말은 아래에 작성: ex) Github issue #23


# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 (새로운 기능)
#   fix     : 버그 (버그 수정)
#   refactor: 리팩토링
#   style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs    : 문서 (문서 추가, 수정, 삭제)
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

 

3. git config에 해당 파일 경로를 잡아준다. 

git commit을 할 때 해당 gitMessage 파일을 참조할 수 있게 잡아줘야 한다. 

난 공통 폴더를 만들어 글로벌로 경로를 잡았다

경로 잡는 방법은 다음과 같다 

git config --global commit.template (~./gitGlobal/.gitmessage.txt) 이 괄호 부분에 경로

(괄호는 빼야 함)

 

4. 사용하기 

git add를 하고 git commit을 하면 아래와 같은 화면을 볼 수 있다 

(-m 하지 않는다)

 

 

본인이 설정한 규칙에 맡게 작성해야 한다 

난 vim으로 설정해둬서 vim으로 하였지만 그건 개인 취향에 맞춰서 하면 된다. 

에디터는 아래처럼 설정할 수 있다

git config --global core.editor vim

 

5. 확인하기 

작성 후 push를 하면 이렇게 작성된다.

 

대충 적었지만 

디테일하게 잘 적으면 아무래도 콜라보하는 개발자가 이해하기 쉬울 것이다. 

 

사회와 기술을 점점 함께 일하는 것에 무게를 두고 발전하고 있다.

개인의 성장에 있어서도 함께 일하는 것에 무게를 두면 트렌드에 자연스레 따라갈 수 있지 않을까 싶다.