배경
github을 사용하여 프로젝트를 관리하다보면 pull request(이하 PR)을 아주 많이 요청하곤 한다. PR 요청을 할 때에는 다른 개발자의 이해를 돕기 위해서 작업에 대한 설명을 함께 기재해야 한다. 이때 유용하게 사용할 기능을 설명하고자 한다.
Pull Request 템플릿
만약 PR 요청시 고정된 패턴의 설명문 형식이 필요하다면 pull request 템플릿을 사용하면 된다.
파일 형식
파일은 Markdown(MD) 형식이다. 템플릿 파일을 Markdown 형식으로 기재하여 특정 위치에 놓는다면 PR 요청시 자동으로 템플릿이 로드된다. 이때 파일명은 PULL_REQUEST_TEMPLATE.MD로 생성한다.
파일 위치
%PROJECT_FOLDER%\.github\PULL_REQUEST_TEMPLATE.md
PULL REQUEST 화면
'Software Develop > ETC' 카테고리의 다른 글
| VisualStudio Template 파일 만들기 (VSTemplate) (0) | 2023.01.13 |
|---|---|
| 코드리뷰에 관하여 (0) | 2022.02.08 |