개발/툴

[Github] PR template 생성하기

말고기 2022. 7. 25. 20:26
728x90
반응형

개요

  • github에 pull request를 날릴 때, 팀 내에서 규칙을 표준화 하고 싶을 때가 있다.
  • 이 때 pr template을 설정해두면 공통적으로 필요한 내용을 정의할 수 있다.

설정방법

  1. .github/PULL_REQUEST_TEMPLATE.md 파일을 생성한다.
  2. 원하는 markdown template을 등록한다.
  3. 해당 template은 default로 설정된 branch에 반영되어야 한다. 그렇지 않으면 pr을 생성하더라도 해당 template이 자동으로 적용되지 않는다.

예제

아래와 같이 등록할 수 있다.

## 설명:

- 왜 변경하려는지나 히스토리에 대해서 적어주세요!.

## 변경사항:

- 변경 사항에 대해서 적어주세요

## 잘봐주세요!:

- 어떤 부분들을 자세히 봐주었으면 하는지 가이드라인을 제시해주세요!.

결론

  • 위와 같이 Pull request에 대해서 사전에 필요한 정보들을 표준화 할 수 있다.
  • 다양한 open source에서 적용이 되어 있으니 자신의 team에 맞게 적용하자!!.
728x90
반응형