git 만지면서 이것저것 많이 해보는듯한 …
사실 반쯤은 재밌다고 느껴진다 … 이런건 알아두면 좋은거니까요
적용하면서 시행착오가 있었기에 메모용으로 적어둡니다
Git 커밋 메시지 컨벤션이란 프로젝트 참여자들이 일관된 형식의 커밋 메시지를 작성하기 위한 규칙을 말한다. 현재 여러 개발자들 사이에서 관습적으로 통용되는 가이드라인이 있지만, 각 프로젝트에 따라 별도의 규칙을 만들어 적용하기도 한다.
1.gitmessage 파일 생성
touch .gitmessage.txt
// git 소스코드가 있는 폴더에서 파일 생성
2.템플릿 파일 작성
################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) feat : 로그인 기능 추가
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 예) Close #7
################
# feat : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refact : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################
.gitmessage.txt 파일로 가서 해당 템플릿을 복사해서 붙여넣었다.
3.gitmessage 파일 기본등록 하기
git config --global commit.template .gitmessage.txt
// 해당 템플릿을 기본 템플릿으로 적용
git config commit.template .gitmessage.txt
// 현재 프로젝트에만 템플릿 적용
git config --unset --global commit.template
// 글로벌 템플릿 적용 해제
git config --unset commit.template
// 현재 프로젝트 템플릿 적용 해제
이렇게 하면 git commit을 할 때마다 템플릿이 자동으로 뜨게 된다
4.git add “업로드할 파일”
5.git commit
git commit를 하면 vs code 에디터에선 이런 창이 자동으로 뜬다
#이 붙은 문장은 전부 주석처리 되니 # 없이 제목과 본문 등을 작성하면 된다.
작성하고 그냥 위의 창을 끄면 자동으로 저장된다.
해당 창이 뜨지 않는 경우도 있는데,
이럴 땐 터미널에서 작성해야 한다.
방법은 이렇다…
-
터미널에서는 방향키로 움직여서 편집해야한다. 내용을 작성하고 싶은 위치로 움직여서 i 를 누른다. 그럼 하단에
라는 문구가 뜨면서 내용을 편집할 수 있게 된다. -
내용을 전부 작성한 후
를 눌러 insert상태를 해제한다 -
: wq로 빠져나온다.
+
협업시 가독성을 높이기 위해 이모지 사용이 보편적으로 이루어지고 있는듯…
귀엽고 좋은 것 같다.