들어가며
팀 프로젝트를 할 때 진행 상황을 한 눈에 파악하고, 작업을 효율적으로 관리하기 위해 Issue와 PR을 주로 사용한다. 깃허브에서는 Issue와 PR 템플릿을 만들어 양식을 일일이 적지 않고 편하게 내용만 채울 수 있도록 기능을 제공하고 있다.
이번 포스트에서는 Issue와 PR 템플릿을 만드는 과정에 대해 알아보자.
Issue Template
Settings 탭에 들어가 스크롤을 조금 내리면 Features 항목에 있는 Set up templates 버튼을 누른다.
아래와 같이 템플릿을 선택할 수 있다. 기본 버그 리포트와 기능 추가 템플릿을 제공하고 있으며 수정하는 것도 가능하다.
나는 Issue의 경우 기능 추가, 버그 수정 등을 구분하지 않고 하나의 공통 양식으로 관리할 것이기 때문에 Custom template을 선택하였다.
Preview and edit 버튼을 눌러 템플릿을 편집해주자.
템플릿의 이름, 설명, 양식을 작성해주면 된다.
추가적으로 기본 제목 양식, 담당자, 라벨도 지정할 수 있다.
혹시라도 같은 템플릿 양식을 사용할 사람을 위해 ...
### 💼 작업 설명
<!-- 진행할 작업에 대해 간단하게 설명해주세요 -->
### ✅ To-do
<!-- 해당 작업을 수행하기 위해 해야 할 하위 태스크를 작성해주세요 -->
- [ ] todo 1
- [ ] todo 2
- [ ] todo 3
마지막으로 Propose Change 버튼을 눌러 변경 사항을 커밋한다.
프로젝트 폴더에 마크다운 파일이 하나 추가된 것을 확인할 수 있다.
이제 이슈를 작성해보자. Get started를 누르면 아래와 같이 양식이 채워진 채로 나오는 것을 볼 수 있다.
PR Template
💡 Issue 템플릿은 여러 개를 만들 수 있지만, PR 템플릿은 1개만 가능하다!
이번에는 PR 템플릿을 만들어보자. Add file - Create new file 버튼을 클릭한다.
파일 이름은 .github/pull_request_template.md으로 한다. 다른 디렉토리에 해도 되지만 숨겨진 디렉토리에 하기 위해 .github 하위에 저장하는 것이 일반적이다.
양식을 작성하고 커밋을 통해 반영해준다.
## 🛰️ Issue Number
## 🪐 작업 내용
## 📚 Reference
## ✅ Check List
- [ ] 코드가 정상적으로 컴파일되나요?
- [ ] 테스트 코드를 통과했나요?
- [ ] merge할 브랜치의 위치를 확인했나요?
- [ ] Label을 지정했나요?
