git commit template 적용하여 commit message convention 작성하기

이경섭·2023년 1월 30일

git

목록 보기
2/3

commit type

 feature : 새로운 기능 추가
 fix : 버그 수정
 docs : 문서 수정
 test : 테스트 코드 추가
 refactor : 코드 리팩토링
 style : 코드 의미에 영향을 주지 않는 변경사항
 chore : 빌드 부분 혹은 패키지 매니저 수정사항

git commit templete

# <타입> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성

################
# 본문(추가 설명)을 아랫줄에 작성

################
# 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)

################
# feature : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refactor : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################

# 으로 된 줄은 모두 주석 처리됨.


convention 적용

.gitmessage.txt 파일을 생성

convention을 적용 시킬 프로젝트 파일에 .gitmessage.txt 파일을 만들고 위 convention을 복사 후 저장


Git.config에 적용

git config --local commit.template <.gitmessage.txt 경로>

--local 옵션을 통해 해당 해당 프로젝트에만 부분적으로 적용 가능

(--global을 통해 전체 설정 가능)


🧐 git config?

Git은 내장된 기본 규칙을 따르지만, 설정된 것이 있으면 그에 따른다.
그리고 Git 설정을 Git config를 통해 적용시킨다.

--system

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

--global

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

--local

마지막으로 현재 작업 중인 저장소의 Git 디렉토리에 있는 .git/config 파일을 찾는다.
이 파일은 해당 저장소에만 적용된다. git config 명령에 --local 옵션을 적용한 것과 같다.
(아무런 범위 옵션을 지정하지 않으면 Git은 기본적으로 --local 옵션을 적용한다)

각 설정 파일에 중복된 설정이 있으면 설명한 “순서대로” 덮어쓴다.
예를 들어 /etc/gitconfiggit/config에 같은 설정이 들어 있다면 .git/config 에 있는 설정을 사용한다.


git commit

git commit 입력 시 convention이 적용된 것을 확인할 수 있으며
취향에 맞는 editer를 설정하여 commit message를 작성하면 된다.


Reference)
https://chanhuiseok.github.io/posts/git-4/
https://sujinlee.me/professional-github/
https://velog.io/@bky373/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%ED%85%9C%ED%94%8C%EB%A6%BF
https://velog.io/@bky373/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%ED%85%9C%ED%94%8C%EB%A6%BF

0개의 댓글