[Github] 이슈 템플릿과 PR 템플릿 생성해 적용하기

Github에서 Issue와 PR (Pull Request)를 사용할 때, 템플릿을 설정해두면, 일관성을 유지할 수 있고 적어야 하는 내용을 빠트리지 않을 수 있다.

 

Issue template 생성 및 적용

 

(1) issue template을 적용할 repository에 들어가 settings를 클릭해준다.

 

(2) settings의 General 탭에서 Features - Issues의 set up templates (초록색 버튼)를 누른다.

(3) 템플릿을 선택한다.

 

(4) 아래 사진은 custom template을 선택한 결과이다. template name (다른 template과 구별할 수 있는 이름), about (템플릿 설명), template content (템플릿 내용)을 작성해준다 (필수값). 추가적으로 issue default title (이슈 생성 시에 나타날 기본 제목), assignees(담당자), labels(라벨)도 설정해줄 수 있다 (선택값).

작성 중

작성 완료

(5) 마지막으로 상단의 propose changes(초록색 버튼)를 누른 후 커밋해주면 template이 생성된다.

 

이제 생성된 템플릿을 골라 이슈를 작성할 수 있다.

이슈

템플릿 선택

레포지토리에서도 .github 폴더가 생성됐다. github/ISSUE_TEMPLATE 내에 작성한 템플릿이 md 파일로 들어가 있는 것을 확인할 수 있다.

---

PR template 생성 및 적용

PR 템플릿은 issue template과 다르게 md 파일에 직접 작성해줬다.

 

(1) .github 파일 내에 pull_request_template.md 파일을 생성한다. (template을 여러 개 생성하고 싶다면 PULL_REQUEST_TEMPLATE 폴더를 생성한 뒤에 원하는 파일명을 입력해 생성할 수 있다고 한다. 자세한 내용은 참고 링크에서 볼 수 있을 것이다.)

 

(2) 파일에 템플릿 내용을 작성한다. (title 부분은 혹시나 해서 작성해봤는데 적용 안 된다.)

 

 

Pull request를 작성할 때 template이 잘 뜨는 것을 확인할 수 있다. (PR 작성 시 #을 입력하면 열려있는 이슈 목록이 떠서 이슈와 PR을 연결할 수 있다.)

---

참고

issue template

https://velog.io/@yulhee741/Github-Issue-Templates%EC%9C%BC%EB%A1%9C-Issue-%EC%89%BD%EA%B3%A0-%EC%B2%B4%EA%B3%84%EC%A0%81%EC%9D%B4%EA%B2%8C-%EC%9E%91%EC%84%B1%ED%95%B4%EB%B3%B4%EA%B8%B0

Github Issue Templates으로 Issue 쉽고 체계적이게 작성해보기

https://computer-science-student.tistory.com/644

[GitHub] 깃허브 이슈(issue) 템플릿 만들기

https://blog.crazzero.com/174

[Git] 깃헙에서 이슈템플릿 설정하기

https://shinsunyoung.tistory.com/35

깃허브 이슈 템플릿 만들기

 

---

pull request template

https://docs.github.com/ko/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

리포지토리에 대한 끌어오기 요청 템플릿 만들기 - GitHub Docs

https://2jinishappy.tistory.com/337

좋은 Pull Request를 만드는 방법과 PR Template 구성