우아한테크코스 레벨 3 (VoTogether팀) 2주차 - 깃 PR, 이슈 템플릿 등록하는 방법 ,PR이 merge 되었을 때 관련 이슈를 자동으로 closed 하는 방법 , PR을 팀원 몇명 이상이 Approve 해줘야 머지할 수 있도록..
PR 템플릿 등록하는 방법
PULL_REQUEST_TEMPLATE.md 파일을 .gihhub 폴더에 넣어줍니다.
PULL_REQUEST_TEMPLATE.md
## 🔥 연관 이슈
close: #
## 📝 작업 요약
수행할 작업을 1~2줄 사이로 요약해주세요.
## ⏰ 소요 시간
기능 구현에 소요된 시간을 적어주세요. (추정했던 시간과 다르다면 이유도 함께)
## 🔎 작업 상세 설명
주요 기능 및 로직에 관해 설명해주세요.
## 🌟 논의 사항
크루들과 이야기 해보고 싶은 부분을 적어주세요.
이슈 템플릿 등록하는 방법
1. 레포지토리 세팅에 들어갑니다.
2. 밑으로 내리면 Features - Issues - Set up templates 버튼을 눌러줍니다.
저의 경우 버그와 기능 두 개를 설정해주었습니다.
버그 관련 이슈 템플릿
## 🐛 현재 상황
<!-- 버그 설명 -->
## 📃 세부 사항
<!-- 수정/구현해야 할 내용 -->
## ✅ 투두리스트
- [ ] item
- [ ] item
## 🔗 참고 자료
버그 제보 관련 이슈 템플릿
### 버그 사항
해당 버그를 **자세하게** 적어주세요 😊
### 버그 simulation
버그를 발견하게 된 상황을 단계별로 적어주세요 😊
### 원하던 상황
원했던 상황을 자세하게 적어주세요 😊
### **Screenshots**
기능 관련 이슈 템플릿
## ✨ 추가 기능
<!-- 어떤 기능을 개발 -->
## 📆 일정 추정
<!-- 기능 구현에 소요되는 시간, 구현 시작/종료일 등 -->
## 📃 세부 사항
<!-- 사용할 기술, 패턴 등
기능 구현 시 다른 사람들이 알아야 할 점 -->
## ✅ 투두리스트
- [ ] item
- [ ] item
## 🔗 참고 자료
커밋 메세지를 남길 수 있는 데 이 때 main에서 바로 남길 수도 있고, 새로운 브런치에서 커밋을 남길 수 있습니다.
PR이 merge 되었을 때 관련 이슈를 자동으로 closed 하는 방법
1. 이슈 생성하기
2. 키워드를 사용하여 Pull Request 를 issue에 연결하기
Linking a pull request to an issue - GitHub Docs
You can link a pull request or branch to an issue to show that a fix is in progress and to automatically close the issue when the pull request or branch is merged.
docs.github.com
Pull Request 또는 Pull Request 시 작성하는 메세지에서 지원되는 키워드를 사용하여 issue에 연결할 수 있습니다. 종료 키워드는 다음과 같습니다.
- close
- closes
- closed
- fix
- fixes
- fixed
- resolve
- resolves
- resolved
PR을 머지하면 이슈가 자동으로 closed 됩니다 !
PR로 머지할 때 커밋 기록을 여러개가 아닌 하나로 묶어서 남기는 방법
Squash and merge 버튼을 누르면 커밋 기록을 하나로 묶어서 남길 수 있습니다.
PR을 팀원 몇명 이상이 Approve 해줘야 머지할 수 있도록 하는 규칙 설정
레포지토리 -> Settings -> Branches -> Protect matching branches 탭에서 Require a pull request before merging을 체크해줍니다.
설정해줘야 할 것은 적용할 branch의 이름 패턴을 입력해야 합니다.
그리고 몇 명이 Approve 해줄지 설정해주고 맨 밑에서 create를 눌러주면 설정이 됩니다.