[github] pr template 적용하기

이지수·2024년 12월 31일

1. PR template 사용하게 된 배경

2024 팀 회고 중 코드 리뷰와 관련해 아쉬웠던 점들을 이야기하게 되었다.

이전 회사에서는 회의실을 잡고 자신의 코드에 대해 설명하는 시간을 종종 가졌다. 그 과정에서 새로운 것을 많이 배웠고, 코드를 명확히 설명하려면 스스로 충분히 이해하고 있어야 한다는 점을 깨달았다. 또, 이를 말로 표현하는 능력도 키울 수 있었다.

이런 좋았던 경험을 토대로 말로 설명하는 코드 리뷰를 팀에서도 해보고 싶다고 의견을 드렸다. 이에 대해 팀장님께서는 "PR을 올릴 때 내용을 더 구체적으로 작성해보면 어떻겠냐"는 제안을 주셨다. 히스토리를 모르는 사람도 내용을 이해할 수 있을 정도로 상세히 작성하면서 코드 리뷰 문화를 만들어보자는 것이었다.

이 제안을 바탕으로, PR 템플릿을 만들어 적용해서 팀 컨벤션으로 가져가보기로 했다.

2. PR이 중요한 이유

잠깐 pr 작성이 중요한 이유를 다시 정리해보면,

코드 리뷰를 통해 팀원간의 코드 스타일을 맞출 수 있고, 혼자서 놓칠 수 있는 요소도 발견할 수 있다.
동료가 하던 작업을 갑자기 내가 받아서 하게 될 수도 있고, 나중에 후속 작업을 내가 맡을 수도 있다.
코드 퀄리티를 함께 높일 수 있는 방법이다.

3. Github Pr template 추가하기

3-1. pull_request_template.md 파일 생성

프로젝트 repository에 파일을 생성한다.

아래의 세가지 위치 중에 하나에 추가하면 된다.

루트 디렉토리
docs 디렉토리
.github 디렉토리

나는 .github 디렉토리에 생성했다.

.github/pull_request_template.md

3-2. 템플릿 작성하기

PR에 작성될 내용은 작업의 목적, 변경 사항, 상세 작업 내용이 필요하다고 생각했다. 이를 바탕으로 ChatGPT의 도움을 받아 조금 더 정리하고 살을 붙여보았다.

# 🚀 PR 요약 (Summary)

- 작업한 주요 내용과 목적을 간단히 설명해주세요.

---

## 📂 변경 사항 (Changes)

- **추가**:
- **수정**:
- **삭제**:

---

## 🛠️ 작업 내용 상세 (How)

- 주요 변경 사항과 해결 방법 설명:

---

## ✅ 체크리스트 (Checklist)

- [ ] 코드가 의도한 대로 동작하는지 테스트 완료
- [ ] 스타일 가이드에 맞게 작성
- [ ] 기존 기능에 영향을 주지 않음
- [ ] 관련 문서를 업데이트했거나 업데이트가 필요하지 않음

---

## 📱 UI 변경사항 (Screenshots, Optional)

UI 작업이 포함된 경우 Before/After 스크린샷 첨부

| Before   | After    |
| -------- | -------- |
| (이미지) | (이미지) |

---

## ⚠️ 주의 사항 (Notes)

- ***

## 🧩 추가 정보 (Additional Context)

- 디자인 파일: [Figma 링크](https://figma.com/)
- 참고 문서: [API 명세서](https://example.com/)

그런데 막상 적용해보니 너무 길고, 겹치는 내용도 있어 문서화에 더 시간을 쓸 것 같아서 좀 더 간단하게 줄여 보았다.

## 💡 Motivation

PR을 작성한 목적과 배경을 간단히 설명해주세요.

## 🔑 Key Changes

주요 변화와 작업 내용을 상세히 적어주세요.

## 👀 To Reviewer

리뷰어가 확인해야 할 사항이나 주의점이 있으면 작성해주세요.

## 📎 Additional Information

참고할 만한 다른 문서가 있으면 적어주세요.

## ✅ Checklist

[] 코드가 의도대로 동작하는지 테스트 완료
[] 스타일 가이드 준수
[] 기존 기능에 영향 없음
[] 관련 문서 업데이트 여부 확인