GitHub PR 템플릿

 

 

 

GITHUB PULL REQUEST SYSTEM

Collaboration & Engineering

협업 효율을 극대화하는 GitHub PR 표준 템플릿

포스트 요약: 단순 코드 전달을 넘어 문제 정의, 아키텍처 변화, 운영 리스크까지 한눈에 파악할 수 있는 고도화된 Pull Request 양식을 제안합니다.

운영 원칙 및 가이드

[ Protocol: Pull Request Management ]

■ 선택적 상세화: PR 태그에 체크한 항목의 상세 내용(details)만 열고 나머지는 삭제하여 리뷰어의 피로도를 낮춥니다.

■ 맥락 우선주의: 코드를 보기 전, 변경의 '이유'와 '영향도'를 먼저 이해할 수 있도록 구성합니다.

GitHub PR 표준 템플릿 (Full)

아래 마크다운 내용을 .github/PULL_REQUEST_TEMPLATE.md 파일에 적용하여 사용하세요.

 

 

 

# [ Pull Request ]

> [ Title Convention ]
> **type(scope): summary**
> 예) `fix(stt): 무음 환경에서 환각 텍스트 생성 문제 해결 (제목은 항상 한국어로 기술)`

---

## [ TAG: PR Type ]
- [ ] feat (기능 추가)
- [ ] fix (버그 수정)
- [ ] refactor (리팩토링)
- [ ] chore (환경/설정/정리)
- [ ] docs (문서)
- [ ] test (테스트)
- [ ] infra (배포/인프라)
- [ ] hotfix (긴급 수정)

---

## 1. 개요 (Overview)
- **작업 목적**: 
- **배경 / 문제 인식**: 
- **관련 이슈**: close #

---

## 2. 문제 정의 (Problem)
### 발생 조건
- 구체적인 발생 상황 기술
### 문제 현상
- 시스템 또는 사용자 관점의 증상 기술
### 잠재적 위험
- [ ] 성능 / [ ] 안정성 / [ ] 데이터 무결성 / [ ] 보안

---

## 3. 해결 전략 (Solution)
### 접근 방식
- 문제 해결을 위한 전체 전략 요약
### 적용 기술 / 로직
1. 
2. 
3. 
### 대안 검토
- 고려했으나 채택하지 않은 방법과 그 사유

---

## 4. 수정 내용 / 작업 내용 (What & How)
### 주요 변경 사항
- **Frontend**: 
- **Backend**: 
- **AI / ML**: 
- **Infra**: 

### 변경 흐름
```text
[Before]
기존 처리 흐름

[After]
변경된 처리 흐름
```

---

## 5. 시스템 아키텍처 관점
### 변경 레이어
- [ ] Client / Frontend
- [ ] API / Backend
- [ ] AI / ML
- [ ] DB
- [ ] Infra
### 컴포넌트 역할 변화
- **변경 전**: 
- **변경 후**: 
### 타 서비스 영향
- 없음 / 있음 (상세 기재)

---

## 6. 수정한 파일 목록 (File Changes)
| 구분 | 파일 경로 | 변경 유형 | 설명 |
|----|---------|---------|----|

- **변경 규모**
  - [ ] 소규모 / [ ] 중간 / [ ] 대규모

---

## 7. 테스트 (Test)
### 테스트 환경
- [ ] Local / [ ] Docker / [ ] Dev / [ ] Staging / [ ] Production
### 테스트 시나리오
1. 
2. 
3. 
### 테스트 결과
- **기대 결과**: 
- **실제 결과**: 

---

## 8. 결과 (Result)
- **동작 결과**: 
- **개선 효과**: 
- **부작용 여부**: [ ] 없음 / [ ] 있음 (상세 기재)

---

## 9. Breaking Change 여부
- [ ] 있음 / [ ] 없음
> ※ Breaking Change 발생 시 변경 내용 및 대응 방법을 반드시 기재

---

## 10. 배포 / 운영 영향
- **재배포 필요 여부**: [ ] 필요 / [ ] 불필요
- **설정 / 환경 변수 변경**: [ ] 있음 / [ ] 없음
- **데이터 마이그레이션**: [ ] 있음 / [ ] 없음

---

## [ Reviewer Notes ]
- **중점 리뷰 요청 사항**: 
- **설계 상 고민 / 트레이드오프**: 

---

## [ Checklist ]
- [ ] PR 태그 선택 완료 / [ ] 이슈 연결 완료 / [ ] 테스트 완료 / [ ] 로그 확인 / [ ] 코드 제거 / [ ] 배포 영향 검토 / [ ] 아키텍처 변경 검토

---

## [ Optional Details: 태그별 상세 섹션 ]

<details>
<summary>[ feat ] 기능 개발 상세</summary>
- 기능 설명 / 구현 이유 / 영향 범위
</details>

<details>
<summary>[ fix ] 버그 수정 상세</summary>
- 문제 설명 / 원인 분석 / 해결 방법
</details>

<details>
<summary>[ refactor ] 리팩토링 상세</summary>
- 리팩토링 대상 및 목적 (가독성/유지보수/성능)
</details>

<details>
<summary>[ infra ] 인프라 변경 상세</summary>
- 변경 대상 / 이유 / 롤백 전략
</details>

"Pull Request는 단순히 코드를 합치는 과정이 아니라, 팀의 기술적 부채를 방어하고 지식을 공유하는 가장 중요한 접점입니다."

Last Updated: 2026. 03. 17

TOP