[Github] PR Template 전역으로 설정하여 유지보수 효율적으로 하기

2025. 3. 21. 10:00·Github/PR Template
반응형

1. 개요

Github를 사용하는 조직은 일관된 PR을 작성하기 위하여 PR Template 기능을 사용하면 좋습니다.

하지만 전역으로 설정하는 방법을 모른다면 개별 레포지토리마다 PR 템플릿을 만들어야 하고,
이는 유지보수를 어렵게 만듭니다.

본 글에서는 Github 전역 PR 템플릿을 설정하는 방법에 대해 포스팅하겠습니다.

전역 PR 템플릿이 필요한 경우

  • 개별 레포지토리마다 PR 템플릿을 별도로 관리하고 있음
  • 모든 프로젝트에서 PR 형식의 일관성을 유지하고자 함

전역 PR 템플릿의 장점

  • PR 형식을 조직 전체적으로 일관성 있게 유지 가능
  • 개별 레포지토리에 템플릿을 별도로 만들 필요가 없어서 관리가 쉬움
  • 리뷰어와의 소통 효율성을 증가

2. Github 전역 PR 템플릿 설정 방법

다음과 같이 총 3단계를 통해 쉽게 설정할 수 있습니다.

1단계: `.github` 특수 레포지토리 생성

  • Github 조직(organization)에 `.github`라는 이름의 레포지토리를 생성합니다.
  • 레포지토리는 반드시 `Public`으로 설정해야 합니다.
  • 생성 후, Github에서 자동으로 `special repository`라는 문구가 표시됩니다.

.github 레포지토리 생성

2단계: `.github` 폴더 생성

  • 생성한 `.github` 레포지토리 내부에 다시 `.github`라는 폴더를 생성합니다.
  • 폴더 이름과 레포지토리 이름이 동일하므로 혼동하지 않도록 합니다!

.github 폴더 추가

3단계: `PULL_REQUEST_TEMPLATE.md` 파일 추가

  • `.github` 폴더 내에 `PULL_REQUEST_TEMPLATE.md` 파일을 추가하여,
    마크다운 언어로 PR 기본 템플릿을 작성합니다.
  • 저는 아래와 같이 기능 수정에 관련된 템플릿을 작성했습니다.
# 작업내역
- [요약: ex. 기능 개선/버그 수정]
- [요약: ex. UI 개선/성능 최적화]

---

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

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


## 2. [수정 제목 또는 간단 설명]
- 🚨 문제점
  - 상세 문제 설명 기재
  
- 🔍 원인 분석
  - 발생 원인 설명

- 💡 해결 방법
  - 적용한 해결 방안 설명

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

3. 적용된 모습 확인

위와 같이 설정을 완료하면 조직 내의 모든 레포지토리에서 PR을 작성할 때,
자동으로 `.github > .github > PULL_REQUEST_TEMPLATE.md`에 작성한 템플릿을 자동으로 불러옵니다.

PR을 생성하면 자동으로 템플릿을 불러온다.

4. 결론

Github 전역 PR 템플릿 기능을 사용하면 관리 효율성이 크게 증가합니다.
그러나 Github는 기본적으로 단 하나의 템플릿만 설정할 수 있습니다.

실무에서는 기능 구현, 버그 수정, 리팩토링 등 여러 상황에 따라 다양한 템플릿이 필요한 경우가 많습니다.
다음 포스팅에서는 여러 개의 PR 템플릿을 설정하여 사용하는 방법을 다루도록 하겠습니다.

 

GitHub - coding-duck-org/.github

Contribute to coding-duck-org/.github development by creating an account on GitHub.

github.com

저작자표시 비영리 변경금지 (새창열림)

'Github > PR Template' 카테고리의 다른 글

[Github] PR Template 전역으로 설정하여 유지보수 효율적으로 하기 #2 - 다중 템플릿  (0) 2025.03.24
'Github/PR Template' 카테고리의 다른 글
  • [Github] PR Template 전역으로 설정하여 유지보수 효율적으로 하기 #2 - 다중 템플릿
코딩덕
코딩덕
안드로이드, 리액트 등의 개발 노하우와 최신 AI 기술을 다루는 기술 블로그입니다. 실무 중심의 경험을 바탕으로 마주한 문제와 해결 과정을 체계적으로 기록하며, 개발자에게 실질적으로 도움 되는 프로그래밍 팁과 인사이트를 쉽고 명확하게 공유하고자 합니다.
  • 코딩덕
    개발자가 들려주는 IT 이야기
    코딩덕
  • 전체
    오늘
    어제
    • 분류 전체보기 (66)
      • 안드로이드 (62)
        • 멀티 모듈 (11)
        • 클린 아키텍처 (11)
        • 트러블 슈팅 (5)
        • 코틀린 (3)
        • 코루틴 (2)
        • Compose (1)
        • Compose UI (6)
        • Compose Dialog (8)
        • Compose Paging3 (11)
        • Compose State (2)
        • Util (1)
      • Github (3)
        • PR Template (2)
        • AI Code Review (1)
      • 리액트 (1)
        • NextJs (1)
  • 블로그 메뉴

    • 홈
  • 링크

  • 공지사항

  • 인기 글

  • 태그

    멀티 모듈
    OnBackPressedDispatcher
    UI Layer
    pr template
    안드로이드
    paging3
    Dialog
    ai code review
    클린 아키텍처
    데이터 레이어
    ScrollView
    Github
    ViewModel
    dynamic json
    enum class
    LazyRow
    코루틴
    multi module
    코틀린
    트러블슈팅
    MutableState
    Gradle
    Jetpack Compose
    recyclerview
    flow
    sealed class
    pager
    Usecase
    jsonadapter
    Clean Architecture
  • 최근 댓글

  • 최근 글

  • hELLO· Designed By정상우.v4.10.3
코딩덕
[Github] PR Template 전역으로 설정하여 유지보수 효율적으로 하기
상단으로

티스토리툴바