[Git] commit message 생성과 등록

버전관리와 commit 메세지 작성을 쉽게할 수 있도록 도와주는 gitmessage

매 번 git commit -m "~~~~"을 입력하지 않고 git commit 만 입력하면 된다.

준비물 : .gitmessage.txt 파일 & commit메세지를 통일하는 git config 설정

0. Git Config

• Git은 내장된 기본 규칙을 따르지만, 설정된 것이 있으면 그에 따른다. 그래서 아래의 설정을 다 마친 뒤 반영이 안될 경우에, 직접 /etc/gitconfig 파일에서 설정을 수정해줄 수 있다.
• 설정이 완료되면 위와같이 commit 밑에 template가 설정된다 저기에 경로를 제대로 지정해주면 됨.

--system

• Git은 먼저 /etc/gitconfig 파일을 찾는다. 이 파일은 해당 시스템에 있는 모든 사용자와 모든 저장소에 적용되는 설정 파일이다.
• git config 명령에 --system 옵션을 주면 이 파일을 사용한다.

--global

• 다음으로 Git은 ~/.gitconfig 파일을 찾는다. 이 파일은 해당 사용자에게만 적용되는 설정 파일이다. --global 옵션을 주면 Git은 이 파일을 사용한다.

--local

• 마지막으로 현재 작업 중인 저장소의 Git 디렉토리에 있는 .git/config 파일을 찾는다. 이 파일은 해당 저장소에만 적용된다. git config 명령에 --local 옵션을 적용한 것과 같다. (아무런 범위 옵션을 지정하지 않으면 Git은 기본적으로 --local 옵션을 적용한다)
• 각 설정 파일에 중복된 설정이 있으면 설명한 “순서대로” 덮어쓴다. 예를 들어 .git/config 와 /etc/gitconfig 에 같은 설정이 들어 있다면 .git/config 에 있는 설정을 사용한다.

1. 커밋 메시지 템플릿 설정

• 커밋 시 Git은 commit.template 옵션에 설정한 템플릿 파일을 보여준다.
• 커밋 메시지 템플릿을 지정하면 커밋 메시지를 작성할 때 일정한 스타일을 유지할 수 있다.

템플릿 파일 생성하기

• .git이 있는 현재 폴더 위치에서 아래 명령을 실행해 .gitmessage.txt 파일을 생성한다.
• readme, ignore파일을 생성할때와 같은 방법으로 git message. txt 파일을 만들어준다.

• touch .gitmessage.txt

• vim .gitmessage.txt

---

################ # <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성 # 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지 # 예) feat : 로그인 기능 추가 # 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함) ################ # 본문(구체적인 내용)을 아랫줄에 작성 # 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내) ################ # 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등) # 예) Close #7 ################ # feat : 새로운 기능 추가 # fix : 버그 수정 # docs : 문서 수정 # test : 테스트 코드 추가 # refact : 코드 리팩토링 # style : 코드 의미에 영향을 주지 않는 변경사항 # chore : 빌드 부분 혹은 패키지 매니저 수정사항 ################

---

그리고 .gitmessage.txt파일에 아래와 같은 양식을 붙혀넣기 한다.

팀프로젝트할때, 꼬리말에 날짜와 작성자 이름을 넣었으나, 날짜와 시간 작성자가 모두 함께 남기 때문에 구지 넣을 필요가 없었다는 생각도 했다.

2. 탬플릿 설정하기

1. gitmessage등록

git config --global commit.template .gitmessage.txt

2. 편집시 사용할 화면 설정

그리고 git commit을 입력했을 때 VSC 화면으로 볼것이냐, vim편집기를 볼것이냐에 따라 하나만 설정해주면 된다.

먼저 보통사람들이 잘 사용하는 visual studio code 화면으로 보이기

git config --global core.editor "code --wait"  

git config --global core.editor vim  

전자를 추천하지만 뭐든 똑같다. 전자로 설정을 해주면 git commit 을 눌렀을 때 COMMIT_EDITMSG창이 뜬다.

여기에

머리말 : <feat> : new 기능

본문 : ~~~~~~~

정도 입력하고 ctrl+s로 저장만 하면 commit 이 된다.