Github - Pull request template 작성과 설정

💡Pull request template은 왜 필요할까?

• PR의 내용이 중요한 이유는 Pull Request를 통해 코드 리뷰를 받기 때문입니다.
• 코드 리뷰를 통해 팀원 간의 코드 스타일을 맞출 수 있고, 혼자서는 발견하기 어려운 위험 요소도 발견할 수 있습니다.
• PR 내용만으로도 변경 사항과 이유를 충분히 이해할 수 있어야 합니다.
• PR Template을 만들어 Repository에 추가하면 PR을 할 때 PR body에 template의 내용을 자동으로 볼 수 있습니다.
• PR의 내용을 표준화해서 일관성 있는 좋은 품질의 Pull Request를 유지할 수 있습니다.

 

pull_request_template.md 파일 생성

• 프로젝트의 Repository에서 파일을 생성합니다.
• 템플릿은 다음 위치 중 한 곳에 넣으면 인식합니다.
  • 루트 디렉토리 : pull_request_template.md
  • docs 디렉토리 : docs/pull_request_template.md
  • .github 디렉토리 : .github/pull_request_template.md
• 필자는 .github 디렉토리에 생성했습니다.

 

이미지 출처 : https://docs.github.com

Pull request template 작성

• 이제 생성한 파일에 template 내용을 작성한다.
• template은 심플하게 만들수도 있고 디테일하게 만들 수도 있다. 어떤 유형의 template을 만들지 팀원들과 논의하여 만들어보자
• 아래 링크에서 다양한 유형의 PR template을 확인할 수 있다.
  • pull request templates repository
• 아래 내용은 필자가 작성한 template이다. 팀원들과 논의하여 계속 보강할 예정이다.

## 개요
<!---- 변경 사항 및 관련 이슈에 대해 간단하게 작성해주세요. 어떻게보다 무엇을 왜 수정했는지 설명해주세요. -->

<!---- Resolves: #(Isuue Number) -->

## PR 유형
어떤 변경 사항이 있나요?

- [ ] 새로운 기능 추가
- [ ] 버그 수정
- [ ] CSS 등 사용자 UI 디자인 변경
- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
- [ ] 코드 리팩토링
- [ ] 주석 추가 및 수정
- [ ] 문서 수정
- [ ] 테스트 추가, 테스트 리팩토링
- [ ] 빌드 부분 혹은 패키지 매니저 수정
- [ ] 파일 혹은 폴더명 수정
- [ ] 파일 혹은 폴더 삭제

## PR Checklist
PR이 다음 요구 사항을 충족하는지 확인하세요.

- [ ] 커밋 메시지 컨벤션에 맞게 작성했습니다.  Commit message convention 참고  (Ctrl + 클릭하세요.) 
- [ ] 변경 사항에 대한 테스트를 했습니다.(버그 수정/기능에 대한 테스트).

 

PR을 해서 template이 잘 나오는지 확인해보자!

잘 나온다!

 

참고

https://2jinishappy.tistory.com/337

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates#pull-request-templates

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

https://axolo.co/blog/p/part-3-github-pull-request-template