Commit, Pull Request, issue 템플릿 사용하기

github에서 프로젝트를 진행할 때, 커밋, Pull Request 를 잘 관리하여야 굉장히 수월하다. 특히 여러명이서 작업을 하다보면 각자만의 방식으로 설명을 하는 경우가 많기 때문에 템플릿을 정해서 정해진 양식대로 작성을 하게 되면 한결 편하게 작업을 할 수 있다.

커밋 템플릿 지정하기(.gitmessage.txt)

git 공식 페이지에 나와있는 방법이다.
이 세팅은 로컬 깃에서 유효하며, github에서는 적용이 되지 않는다.
.gitmessage.txt 파일을 레포지터리에 작성 후, 원하는 커밋 양식을 채워둔 후 git config --global commit.template .gitmessage.txt을 설정하면 끝이다. 이제 템플릿을 지정했으니, git commit -m대신에 git commit을 실행하면 vim에디터에 설정해둔 템플릿이 나오고, 수정해서 커밋을 할 수 있다.

풀 리퀘스트 템플릿 지정하기

github docs에서 소개하는 방법이다. 레포지터리에 pull_request_template.md파일에 템플릿 양식을 채워서 올리면 끝이다. 이제 github에서 PR을 만들면 템플릿의 내용이 채워져서 나오는걸 확인할 수 있다.

이슈 템플릿 지정하기

이슈를 만들 때, 템플릿을 지정할 수 있다. 이 기능은 깃허브 레포지터리 환경설정에서 직접 할 수 있다.

설정을 들어가서 위의 이슈 템플릿을 접근하면 아래와 같은 화면이 나오면서 이슈템플릿을 수정할 수 있다.

이렇게 원하는 내용대로 지정을 하면 새로운 이슈를 생성 할 때 아래와 같은 화면이 나오면서 지정된 템플릿대로 이슈를 작성할 수 있다.

결론

간단하게 파일을 추가함으로써 commit과 Pull Request의 템플릿을 지정할 수 있다.
인터넷에 찾아보면 좋은 템플릿 예시가 있으니 찾아서 적용해보자.
포스트를 작성하면서 만든 레포지터리를 참고해 보아도 좋다.
GitHub 사용법