[Git]이슈 템플릿과 PR 템플릿 생성하기

issue 템플릿 생성하기

레포지토리에서 제일 우측 탭인 Settings 에 들어간다. 

 

Set up templates 누르기 !

 

해당 이슈의 역할에 따라 템플릿의 종류를 선택할 수 있다. 

기능 관련 이슈를 생성할 것이기 때문에 Feature request 를 선택하였다. 

 

수정 버튼을 누른 후 이슈 템플릿을 수정해주면 된다. 

마크다운 언어로 작성하며, 나는 다음과 같이 작성했다. 

 

## ✨어떤 기능인가요?
>추가하려는 기능에 대한 간단한 설명을 해주세요

## ✔️TODOS
- [ ] TODO
- [ ] TODO
- [ ] TODO

## 🎶참고할 만한 자료
>공식 문서, 개발 블로그, 강의 자료 등 자유롭게 첨부해주세요.

 

다음으로 Propose changes 버튼을 누른 후 커밋을 진행해주면 된다. 

 

이후 .github 폴더와 본인이 작성한 템플릿의 md 파일이 생성됨을 확인할 수 있다. 

 

 

이제 이슈를 생성하면

 

잘 적용된다 !

 

이슈의 경우 버그를 발견, 기능 구현, 프로젝트 건의와 같은 상황에서 팀원들과 협업하기 위해 사용된다. 

프로젝트마다 이슈의 사용법이 다를 수 있으며, 나의 경우에는 브랜치 생성 전략을 이슈와 함께 사용하고있다. 

이슈마다 브랜치를 생성하는 방식!

 

PR 템플릿 생성하기

이전에 생성된 .github 폴더에 PULL_REQUEST_TEMPLATE.md 파일을 생성해주고 내용을 작성해주면 된다.

 

나는 다음과 같이 작성해주었다. 

## #️⃣연관된 이슈
>PR과 연관된 이슈 번호를 작성해주세요. ex) #이슈 번호, #이슈 번호

- close: #[issue number]

## 🪄작업 내용
>해당 이슈 그리고 이번 PR에서 작업한 내용들을 작성해주세요.
>뷰 작업 내용이 포함되었을 경우 사진 혹은 동영상 파일 첨부를 부탁드립니다!

-
-


## 💖리뷰 요청사항
>특별히 봐주셨으면 하는 부분, 나 좀 잘했다 하는 부분! 기타 당부의 말씀 등 자유롭게 작성해주세요.

-

 

 

잘 적용된다 :)

---

이슈 템플릿과 PR 템플릿 모두 main 브랜치에 위치해 있어야 한다. 

그렇기 때문에 레포지토리 생성 직후 바로 작성해주면 추후 브랜치를 생성하거나 프로젝트를 올릴 때 새롭게 템플릿 생성과 관련된 브랜치를 생성하거나, merge를 진행하는 번거로움을 줄일 수 있다. 

 

깃허브를 꾸미려 하니 점점 마크다운 언어와도 친해지고 있는 중이다...