협업/Git

Github 이슈 & PR 템플릿

Cha_Ji 2021. 12. 13. 03:03

Github에서 Issue를 작성할 때, Pull Request를 작성할 때 양식을 설정할 수 있습니다.
default branch에 작성되어 있어야 적용됩니다.

이슈 템플릿

  • 이슈의 종류별로 템플릿을 만들어 협업할 때 용이하게 사용할 수 있습니다.

작성법

  1. 저장소의 root경로에 .github 폴더를 만듭니다.
  2. .github폴더에 ISSUE_TEMPLATE 폴더를 만듭니다.
  • 여러 템플릿을 추가할 수 있습니다.
    ISSUE_TEMPLATE
  1. 양식에 맞춰 템플릿에 대한 정보를 서술합니다.
  • name과 about은 비워둘 수 없습니다.
---

name: Feature request v0.1  
about: 기능 추가 템플릿입니다.  
title: ''  
labels: ''  
assignees: ''

---
  1. markdown 형식의 본문을 작성하면 Issue를 작성할 때 그대로 사용할 수 있습니다.
## 기술 키워드

-   [ ]

## To Do

-   [ ] 
-   [ ]

## 비고

사용

  1. 이슈를 생성할 때 어떤 템플릿을 사용할지 선택합니다.

이슈 스타트

  1. 템플릿을 선택하면 앞서 작성한 markdown 코드가 미리 작성되어 있습니다.

이슈 작성

PR 템플릿

  • 이슈와 유사하게 템플릿을 만들 수 있습니다.
  • .github폴더에 PULL_REQUEST_TEMPLATE.md를 생성하면 PR을 만들 때 바로 적용됩니다.