[GitHub-TIL] GitHub 협업시 Issue(이슈)와 Pull Request(PR) 템플릿과 설정법

개발자들이 프로젝트 관리 및 협업을 향상시키는 데 유용한 도구로써 꼽는다면

이슈 템플릿과 PR 템플릿이 있죠~

이러한 템플릿을 사용하면 좋은 점이 있는데,

급하신 분들께서는 IssueTemplate 부분부터 보시면 되겠습니다.

---

일관성 유지

템플릿은 일관된 양식과 포맷을 제공 해서

모든 이슈나 PR이 일관되게 작성될 수 있도록 돕고 

프로젝트의 전체적인 가독성과 이해도를 향상시키는 데 도움이 됩니다~

 

필수 정보 제공

템플릿은 필수 입력 필드를 강조해서 필요한 정보가 누락되지 않도록 하고

팀원들은 작업에 필요한 정보를 쉽게 확인이 가능하다는 것

 

표준화된 작업 흐름

템플릿은 작업을 새로이 시작하는 데 도움을 줄 뿐만 아니라 표준화된 작업 흐름을 강조하는데

팀은 일관된 방식으로 작업을 진행할 수 있고, 혼란을 최소화 시켜주죠

 

효율성 향상

템플릿은 일반적인 이슈나 PR 작성에 소요되는 시간을 줄여주고,

필수 정보를 채우는 것에 집중함으로써 팀원들은

더 많은 시간을 실제 작업에 투자가 가능하다는 점이죠

 

품질 향상

템플릿을 사용함으로써 팀은 놓치기 쉬운 사항들을 간과하지 않을 수 있고,

프로젝트의 품질을 향상시키고 오류를 줄여줄 수 있어요

 

문서화

템플릿은 프로젝트의 문서화에도 기여하는데,

이슈나 PR이 명확하게 작성되면

나중에 해당 작업에 대한 문서화가 훨씬 용이해집니다.

---

Issue Template

먼저 왼쪽이미지 처럼 레포지토리의 [Setting] 탭으로 들어간 뒤, 

Features(특징) 항목의 Issues(이슈)에 있는

‘Set up templates’ 버튼을 누르면 이슈 템플릿을 등록할 수 있는 화면이 나옵니다.

오른쪽 이미지에서 ‘Add template:select'를 클릭해서

원하는 형식의 이슈 템플릿을 추가할 수 있고,

보통은 이슈 템플릿은 크게 "버그 리포트"와 "기능 요청" 이슈로 나눠집니다.

 

요 2개를 선택해서 꺼내었다면 이제 템플릿 내용을 수정을 하면 됩니다.

 

이곳에서 원하시는 대로 수정하면됩니다.

"수정을 한다는것까지 이해했는데 어떤 내용으로 수정할지 모르겠다"

구글링을 하다보면 여러가지 방식의 이슈 내용이 떠돌아 다니는데

 

필자가 보여주는 방식은 비교적 정석적인(?) 표현 일 뿐이며,
따라한다고 해서 문제될 것은 전혀 없습니다..!

자기 자신만의 이슈 내용으로 작업하는 것을 권장드리며,

아래 이미지를 참고해주세요

 

보통의 이슈 템플릿 설정의 내용으로는 다음과 같아요

필자가 협업하면서 사용했던 기능 요청 이슈는 아래내용을 사용했고,

## 🛠️ 작업목표
- 

## 📝 To-do
- [ ] 
- [ ] 
- [ ] 

### 참고사항
-

 

버그 요청 이슈는 아래내용과 같습니다.

## 🐞  버그 내용
- 


## 👾 버그 발생 상황
- 


## 👀 원래 기대했던 결과
- 


## 📷 스크린샷
> [가이드라인]
>> |기능|사진| 기능에는 구현된 혹은 작업한 것을 입력해주고 사진에는 사진의 링크를 걸어줍니다.
|:---:|:---:| 이부분은 지우지 마세요, 테이블을 만들어주는 문법입니다. (가운데정렬된 테이블입니다.)
사진 링크의 경우 캡쳐를 진행한 후 command + C, V를 통해서 즉시 입력이 가능합니다.
||| 의경우 반드시 띄어쓰기 없애 주셔야합니다.
아래에 예시를 드리겠습니다. 
3개의 형태를 유지해주고 단락띄기는 가능합니다.

>> |기능|사진|
|:---:|:---:|
|기능이름|사진링크|
|기능이름|사진링크|
|기능이름|사진링크|
|기능이름|사진링크|

이런식으로 가능합니다.

|기능|사진|
|:---:|:---:|
|||

이처럼 필자가 협업하며 사용했던 방식입니다.

 

모두 수정을 하였다면 아래 순서와 같이 진행해주면 됩니다.

 

대강 이렇게 하신 뒤 다시 내 레포지스토리 화면으로 가게 됩니다.

참고로 이슈 템플릿을 수정하고 싶다면 다시 같은 방법으로 가면 수정할 수 있고,

사람마다 다르지만 필자는 레이블도 수정했으면 좋을 것 같아서

요 화면에서 간단한 작업을 할 예정이라면 

 

필자는 이와같이 꾸미고, 나머지 레이블을 지우고 작업을 간결화 시켰습니다.

 

이후

이슈를 만들어 봅시다.

적용한 이슈 템플릿 양식입니다.

 

원하는 이슈 템플릿으로 ‘Get started’를 클릭하면 템플릿을 사용할 수 있게됩니다.

---

PR Template

PR 템플릿은 Issue 템플릿처럼 여러 개를 설정할 수 없습니다.

마찬가지로 마크다운 문법을 지원하며, 적용하는 방법은 간단한데,

기본 브랜치로 설정된 브랜치(default는 main)에서 프로젝트의 최상위 경로를 기준으로 

.github 폴더를 만들고 그 안에 템플릿 내용을 담은 PULL_REQUEST_TEMPLATE.md 파일을 만들면 됩니다.

 

단계는 쉽게

1 단계 : pull_request_template.md 파일 생성

2 단계 : Pull request template 작성

끝입니다.

 

근데 처음 하시는 분들은 많이 헷갈릴 수 있습니다.

 

[1 단계 상세 내용]

프로젝트의 Repository에서 파일을 생성

↓

[템플릿은 다음 위치 중 한 곳에 넣으면 인식]

루트 디렉토리 : pull_request_template.md docs

디렉토리 : docs/pull_request_template.md .github

디렉토리 : .github/pull_request_template.md

필자는 .github 디렉토리에 생성했습니다.

↓

 

PR을 읽는 목적은 주로 코드 리뷰에 있습니다.

작업 내용(PR 요약)과 함께 코드를 읽는 데 걸리는 예상 시간,

리뷰어에게 요청하고 싶은 점(특별하게 봐주었으면 하는 점),

결과 화면 등을 첨부해주면 좋다 등등

(이러한 양식엔 정해진 컨벤션이 있는 것은 아니니까 각자 팀 상황에 맞춰서 결정하는 게 좋습니다.)

필자의 경우 협업 하며 진행한 PR 경우 아래와 같이 사용했고

## 🔥 *Pull requests*

⛳️ **작업한 브랜치**
- #

👷 **작업한 내용**
- 

## 🚨 참고 사항
- 

## 📸 스크린샷
|기능|스크린샷|
|:--:|:--:|
|||

## 📟 관련 이슈
- Resolved: #

참고로 #의 경우 이슈를 기반으로 한 자신 브랜치를 확인 및 선택할 수 있고,

이제 PR을 생성할 때 위와 같이 파일에 작성한 템플릿이 자동 완성 됩니다.