Github PR 템플릿 설정하기

하마·2025년 4월 21일
1

git & github

목록 보기
14/14
post-thumbnail

1. PR 템플릿 생성하기


지난 시간에 했던 이슈 템플릿 만들기를 따라했으면 리포지토리에 .github/ 경로가 자동으로 생겼을 겁니다.

우측 위 Add file 을 클릭해 .github/pull_request_template.md 마크다운 파일을 생성해줍니다.

## PR 타입 (하나 이상의 PR 타입을 선택해주세요)
- [ ] 기능 추가
- [ ] 기능 삭제
- [ ] 버그 수정
- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트

## 반영 브랜치
- ex) feat/signup -> dev

## 💡 구현 내용 요약
- 어떤 작업을 했는지 간단히 설명

## ✅ 체크리스트
- [ ] 코드 컨벤션을 지켰나요?
- [ ] 로직 테스트를 완료했나요?
- [ ] 문서 수정이 필요한가요?

## 🔍 관련 이슈
- 관련 이슈 번호: 

## 📝 기타 참고 사항
- 리뷰어에게 추가로 공유할 내용이 있다면 작성

입맛대로 템플릿을 만들어줍니다.

다 만들었으면 우측 위에 있는 Commit changes 버튼을 클릭해줍니다.

커밋 메세지는 Docs: PR 템플릿 추가 정도가 좋겠네요.


2. PR 템플릿 활용하기

그러면 우리가 만든 pr 템플릿이 자동으로 적용됩니다.

그리고 요구사항에 맞도록 PR 본문을 채워줍니다.

관련 이슈는 이전 포스트 (PR과 이슈를 함께 사용하기)를 참조해주시기 바랍니다.

PR 제목 컨벤션

[#이슈번호] prefix: contents 형식을 사용하는 게 깔끔해 보입니다.
위에서 사용했던 [#3] Feat: 회원가입 서비스 개발 과 같은 느낌으로!

우측에 있는 Labels, Assigness를 적절히 설정해주고 PR을 보내봅시다.

팀원이 있다면 코드 리뷰 등을 진행하고 머지를 진행합시다.

PR 커밋 메세지

자동으로 생성되는 커밋메세지는 이렇게 생겼는데,
이거 말고 저희 컨벤션 지켜서 머지합시다.

보통 PR을 보낼 때는 이슈를 기반으로 보낼겁니다.
그러면 이슈의 성격에 맞게 커밋 컨벤션을 작성하면 좋겠죠?

현재 PR은 [Feature] 회원가입 서비스 개발 #3 이슈와 관련있기 때문에,
Feat: 회원가입 서비스 개발 (#3) 정도면 좋겠습니다.

만약 관련 이슈가 없다면 작업한 내용을 한 줄로 요약해서 메세지를 보내면 좋겠죠?
ex) Style: 전체적인 코딩 스타일 개선
ex) Chore: .gitignore 추가


3. 완성

중간에 있는거는 무시해주시구요.....ㅠ
맨 위에 있는 게 PR이 머지된 커밋 메세지입니다.

컨벤션을 지켜서 작성하면 커밋 히스토리를 살펴보기 좋겠죠?

0개의 댓글