Intro

Github에서 글을 작성 할 때 미리 지정된 template을 사용할 수 있습니다.
아래는 대표적인 template입니다.

• Issue template
• PR template

PR template 설정

Issue template의 경우 Repository의 setting 항목에서 쉽게 설정이 가능하지만 PR template의 경우 template 만들어 push해주어야 합니다.

Single template

pull_request_template.md 를 작성하면 됩니다.

• 해당 파일의 경로는 아래와 같습니다.

  1. .github/pull_request_template.md or
  2. docs/pull_request_template.md or
  3. pull_request_template.md (root)

• workflow와 다르게main 브랜치에 있는 경우에만 적용됩니다.

Multiple template

pull_request_template/ 디렉토리 내에 작성하면 됩니다.

• 해당 파일들의 경로는 아래와 같습니다.

  1. .github/pull_request_template/template1.md or
  2. docs/pull_request_template/template1.md or
  3. pull_request_template/template1.md (root)

---

문제 상황

1. 여러가지 성격의 PR이 존재

2. Multiple PR의 경우 UI가 존재 X, 쿼리 파라미터로 지정해주어야 한다는 글 발견

부가적으로 확인해야 할 사항

1. Single template과 Multiple template둘 다 있는 경우 충돌 가능성 확인 필요

2. 충돌한다면 순서에 상관 있는지

---

Spike

Multiple PR의 경우 UI가 존재 X, 쿼리 파라미터로 지정해주어야 한다

UI

• UI가 뜨지 않았습니다.

Query parameter

• 쿼리 파라미터를 사용하니 적용되었습니다.
• pr link 예시입니다.https://github.com/{owner}/{repo}/compare/{base_branch}...{compare_branch}?expand=1&template={TEMPLATE_FILE_NAME}

Single template과 Multiple template 둘 다 있는 경우 충돌 가능성

Single과 Multiple 모두 존재

• 충돌은 발생하지 않았습니다.
• 기본적으로 Single template이 적용되고 query parameter를 적용하면 multiple template으로 전환됩니다.

생성 순서

• 생성 순서는 상관 없었습니다.
  • 충돌이 나지 않았기에 확인해 볼 필요는 없었지만 테스트해보았습니다.
  • Single 생성 후 multiple 생성, multiple 생성 후 single 생성 이 두가지를 진행했습니다.

Single 생성 후 multiple 생성

• Single template
  
• Multiple template

Multiple 생성 후 single 생성

• Single template
  
• Multiple template