[Github] PR Template 전역으로 설정하여 유지보수 효율적으로 하기 #2 - 다중 템플릿

1. 개요

앞선 글에서는 `.github` 레포지토리를 통해 Github 조직 내에서 PR 템플릿을 전역으로 설정하는 방법에 대해 다루었습니다. 이를 통해 모든 프로젝트에서 일관된 PR 포맷을 자동으로 적용할 수 있었지만, 아쉬운 점이 한 가지 있었습니다.

Github는 기본적으로 하나의 PR 템플릿만 지원하기 때문에
실무에서 자주 필요한 다양한 상황별 템플릿을 선택하여 사용하는 것이 불가능합니다.

이번 글에서는 이러한 제약을 우회하여, 전역 PR 템플릿을 사용하면서도 다중 템플릿을 선택적으로 사용하는 방법에 대해 소개하겠습니다.

다중 템플릿을 선택하는 모습

---

2. 전역 환경에서 다중 템플릿을 구성하는 방법

Github는 다중 템플릿 선택 UI를 제공하지 않기 때문에, 사용자가 직접 필요한 템플릿을 선택할 수 있도록 하는 방식으로 구현해야 합니다.

2-1. pull_request_template.md 파일에 템플릿 링크 추가

`.github/pull_request_template.md`파일 안에 여러 템플릿을 선택할 수 있는 링크를 넣습니다.

`Preview` 탭을 누르고 템플릿을 선택해주세요.

* [기능 구현](?expand=1&template=feature_template.md)
* [버그 수정](?expand=1&template=bugfix_template.md)

이렇게 하면 PR을 만들 때 위 마크다운이 보이게 되고, 사용자가 원하는 템플릿을 클릭하면 선택한 템플릿의 내용이 채워지게 됩니다.

2-2. 템플릿 파일을 별도 폴더에 생성

링크가 동작하려면 각각의 템플릿 파일을 `PULL_REQUEST_TEMPLATE`이라는 폴더 안에 개별 마크다운 파일로 저장해야 합니다.

.github/
└── .github/
    ├── pull_request_template.md ← 메인 템플릿
    └── PULL_REQUEST_TEMPLATE/
        ├── feature_template.md   ← 기능 구현용
        └── bugfix_template.md    ← 버그 수정용

저는 간단하게 아래와 같이 기능 구현용, 버그 수정용 마크다운 파일을 추가해 주었습니다.

// bugfix_template.md

# 작업내역
- [요약: ex. 기능 개선/버그 수정]
- [요약: ex. UI 개선/성능 최적화]

---

## 1. [수정 제목 또는 간단 설명]
- 🚨 문제점
  - 상세 문제 설명 기재
 
- 🔍 원인 분석
  - 발생 원인 설명
    
- 💡 해결 방법
  - 적용한 해결 방안 설명

- 🔄 수정 전/후 비교
  |수정 전|수정 후|
  |:-:|:-:|
  |<video src="" />|<video src="" />|

// feature_template.md

# 작업 내역
- [요약: 신규 기능 추가]
- [요약: 기능 개선 등]

---

## 1. [기능 제목 또는 간단 설명]
- 상세 내용 기재
  
  |기능1|기능1|
  |:-:|:-:|
  |<img width="400" src="스크린샷 URL" />|<img width="400" src="스크린샷 URL" />|

3. 최종 흐름 요약

1. PR을 생성할 때, `pull_request_template.md`는 항상 로드되며, 링크 목록을 제공함
2. 사용자는 `Preview`탭에서 원하는 템플릿을 선택함
3. 선택한 템플릿을 기반으로 PR을 작성함

이렇게 구성하면 Github의 전역 템플릿을 사용하면서도 여러 템플릿 중 하나를 선택해서 사용할 수 있는 환경을 만들 수 있습니다.

4. 결론

이번 글에서 소개한 방식은 `pull_request_template.md`파일에 직접 링크를 제공하고, 사용자가 상황에 맞는 템플릿을 활용할 수 있도록 유도하는 방법입니다. Github 기본 기능만으로 구현 가능하며, 조직 전체에 일관성 있는 PR 템플릿을 적용할 수 있는 매우 실용적인 방법이라고 생각합니다.

1편에서 소개한 전역 PR 템플릿 설정 방법과 본 글에서 다룬 다중 템플릿 선택 구조를 결합하여
유지보수성과 일관성을 모두 갖춘 PR 작성 환경을 구축하는 데 도움이 되었기를 바랍니다.

GitHub - coding-duck-org/.github