본문 바로가기
카테고리 없음

[github] 깃허브 Issue Templates, Pull Request (PR) Templates 이용하기

by sum_mit45 2023. 12. 19.
728x90
반응형

깃허브 ISSUE TEMPLATE 만들기

1.  repository 에서 Settings 들어가기

 repository 에서 settings > General > Features > Set up templates 에서 Features 부분에 Issues를 보면 Set up templates 버튼이 있다. 

settings > General > Features > Set up templates 부분을 클릭하면 된다.

2. Add templates 에서 원하는 템플릿을 선택하기

나는 아래와 같이 구성했다. 

Feature Issue와 Bug Issue 템플릿 모습

 

Feature 의 Template Content는 아래와 같이 채웠다. 

## ✏️ Summary
<!-- 어떤 작업을 할 것인지 간략하게 적어주세요 -->

## 📝 ToDo
<!-- 해야 하는 작업을 적어주세요 -->
- [ ] Todo1
- [ ] Todo2
- [ ] Todo3

## 📚 Other information
<!-- 참고할 사항이 있다면 적어주세요 -->
728x90

 

Bug 의  Template Content는 아래와 같이 채웠다. 

## ✏️ Describe the bug
A clear and concise description of what the bug is.

## ❗️ To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## 📍 Expected behavior
A clear and concise description of what you expected to happen.

## 📸  Screenshots
If applicable, add screenshots to help explain your problem.

## 🔎 Additional context
Add any other context about the problem here.

 

깃허브 PULL REQUEST(PR) TEMPLATE 만들기

1.  .github 에서 pull_request_template.md 파일 만들기

content는 아래와 같이 작성하여 만들어주었다. 

## 📌 Issue number and Link
<!-- 관련있는 이슈 번호(#000)을 적어주세요.
  closed #Issue_number를 적어주세요 -->

## ✏️ Summary
<!-- 개요 -->

## 📝 Changes 
<!-- 작업 사항 및 변경로직 -->


## 🔎 PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] angular.io application / infrastructure changes
- [ ] Other... Please describe:

## 📚 Other information
<!-- 참고할 사항이 있다면 적어주세요 -->

 

 

repository > .github 파일안에 이렇게 파일이 작성되어 있다. 

.github 폴더 안의 모습

 

깃허브 TEMPLATE 사용하기

- Issue Template 같은 경우에는  Issues > New Issue 를 클릭하면 내가 만든 템플릿을 이용할 수 있다. 

- Pull Request Template 도 PR을 만들 때 사용할 수 있다.

728x90
반응형