[GitHub 갖고놀기] GitHub pr 관리하기 & 템플릿 생성하기

🥰 깃허브 갖고놀기 기록집

🤔 Intro

• 깃허브로 협업을 하며 풀리퀘 생성 및 관리는 필수적이다.
• 오늘은 pr이 무엇인지에 대해서 간략하게 알아보자!
• 또한, 추가적으로 템플릿을 구성하는 방법도 알아본다.

😀 Start!

목표

• pr에 대해서 알아보기
• pr 템플릿 생성 실습

풀리퀘스트란?

• 내가 작업한 브랜치의 변경사항을, 다른 브랜치에 반영해달라고 요청하는 절차를 말한다

왜 사용할까?

1. 협업에서 안전하고 체계적인 코드 통합
   • 직접 main 브랜치에 푸시하지 않고, 중간에 확인(코드 리뷰)을 거쳐 머지할 수 있다.
   • 코드 품질, 테스트 여부 등을 체크할 수 있어 실수를 줄일 수 있다.
2. 코드 리뷰를 위한 절차
   • 팀원이 코드를 리뷰하고 의견을 남길 수 있어서 코드 품질 향상에 좋다.
3. 기록이 남는다
   • 누가, 언제, 어떤 기능을 어떻게 변경했는지 PR로 이력이 남는다.
4. 자동화된 검사와 연동이 가능하다.
   • PR 시 CI/CD 도구(GitHub Actions 등)로 테스트, 빌드가 자동으로 수행되게 설정이 가능하다.
   • 문제가 생기면 PR 단계에서 미리 차단이 가능하다.

PR 템플릿 생성하기

• PR 템플릿을 직접 생성해서, 프로젝트에 적용해서 사용하면 정형화된 템플릿을 공유하여 생산성을 높일 수 있다.

• 프로젝트 파일 안에 .github 폴더를 생성한다음, pull_request_template.md를 넣는다.
  • 이름은 반드시 “pull_request_template.md”여야 한다! 대문자로 써도 무방하다.

• 나의 경우, 다음과 같이 임의의 템플릿을 생성하였다.
  • 간단하게 pr 요약, 체크리스트, 이슈연결, 참고 사항, 스크린샷으로 구성하였다.

## 📝 PR 요약
- 이 PR에서 어떤 작업을 했는지 간단히 설명해주세요.

## ✅ 체크리스트
- [ ] 코드가 정상적으로 동작함
- [ ] 주석 및 문서가 적절히 작성됨
- [ ] 관련 이슈에 연결됨 (예: closes #1)

## 📎 관련 이슈
- 이슈 번호 또는 설명

## 💬 기타 참고 사항
- 추가로 리뷰어가 알아야 할 사항이 있다면 작성

## 🖼️ 스크린샷
- 추가할 스크린샷이 있다면 작성

• 여러개의 PR 템플릿을 적용하고 싶다면, PULL_REQUEST_TEMPLATE/ 안에 각각의 md 파일을 만들면 된다.

📁 .github
└── PULL_REQUEST_TEMPLATE/
    ├── feature.md
    ├── bugfix.md
    └── refactor.md

• pr 템플릿이 구성되었으면 add commit push로 올려준다.
• 참고로 이 pr 템플릿의 경우 default branch (dev or main / 머지 대상이 되는 베이스 브랜치를 말한다. )에 올라가 있어야 적용된다.

PR 템플릿 TEST

• 현재 test-repo에는 브랜치가 dev > main 이므로, dev에서 변경사항을 추가하고 main에 pr을 요청해보겠다.

• 변경사항이 있어야 PR 작성이 가능하므로, dev 브랜치 안에 사진 파일을 하나 추가해주었다.
• 이제 dev > main으로 merge를 요청하는 pr을 하나 생성해보자~

• 설정해둔 markdown 템플릿이 잘 들어오는 것을 볼 수 있다:)

• 프리뷰를 이용하면 템플릿이 적용된 모습을 미리 보는것도 가능하다!