Skip to content

Commit

Permalink
docs: Issue, PR 템플릿 작성
Browse files Browse the repository at this point in the history
  • Loading branch information
kmebin committed Oct 27, 2023
1 parent f3e5faa commit 780baee
Show file tree
Hide file tree
Showing 5 changed files with 115 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: "🐞 Bug"
description: "버그가 발생했어요."
title: "OO 버그 해결"
labels: "🍀 BE, 🐛 fix"
body:
- type: checkboxes
attributes:
label: 📋 Checklist
description: 반드시 먼저 체크해주세요!
options:
- label: 📁 프로젝트는 등록했나요?
- label: 🎯 마일스톤은 등록했나요?
- type: textarea
attributes:
label: 🐞 Problem
description: 현재 발생한 문제에 대해 설명해주세요.
placeholder: 리스트 형태로 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 🌱 Expected Result
description: 정상 동작일 때의 결과를 설명해주세요.
placeholder: 리스트 형태로 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 🙋🏻 More
description: 관련된 Discussion 등이 있다면 첨부해주세요.
placeholder: 리스트 형태로 적어주세요!
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "✨ Feature"
description: "새로운 기능이 필요해요."
title: "OO 기능 구현"
labels: "🍀 BE, ✨ feature"
body:
- type: checkboxes
attributes:
label: 📋 Checklist
description: 반드시 먼저 체크해주세요!
options:
- label: 📁 프로젝트는 등록했나요?
- label: 🎯 마일스톤은 등록했나요?
- type: textarea
attributes:
label: ✅ Tasks
description: 해야 하는 일에 대한 Tasks를 작성해주세요.
placeholder: 체크 박스 형태로 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 🙋🏻 More
description: 관련된 Discussion 등이 있다면 첨부해주세요.
placeholder: 리스트 형태로 적어주세요!
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "🔨 Refactor"
description: "리팩터링 해야 할 부분이 있어요."
title: "OO 리팩터링"
labels: "🍀 BE, ♻️ refactor"
body:
- type: checkboxes
attributes:
label: 📋 Checklist
description: 반드시 먼저 체크해주세요!
options:
- label: 📁 프로젝트는 등록했나요?
- label: 🎯 마일스톤은 등록했나요?
- type: textarea
attributes:
label: ✅ Tasks
description: 해야 하는 일에 대한 Tasks를 작성해주세요.
placeholder: 체크 박스 형태로 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 🙋🏻 More
description: 관련된 Discussion 등이 있다면 첨부해주세요.
placeholder: 리스트 형태로 적어주세요!
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "🧚🏻‍♀️ Support"
description: "기능 개발 외의 작업이 필요해요."
title: "OO 작업"
labels: "🍀 BE, ✅ test, 📦 chore, 📝 docs, ⚙️ setting, 🔥 remove"
body:
- type: checkboxes
attributes:
label: 📋 Checklist
description: 반드시 먼저 체크해주세요!
options:
- label: 🏷 필요한 라벨만 등록했나요?
- label: 📁 프로젝트는 등록했나요?
- label: 🎯 마일스톤은 등록했나요?
- type: textarea
attributes:
label: ✅ Tasks
description: 해야 하는 일에 대한 Tasks를 작성해주세요.
placeholder: 체크 박스 형태로 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 🙋🏻 More
description: 관련된 Discussion 등이 있다면 첨부해주세요.
placeholder: 리스트 형태로 적어주세요!
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- PR 제목은 커밋 메세지 컨벤션 형식으로 작성해주세요 ex) feat: 유저 정보 조회 API 구현 -->

## 🧩 이슈 번호 <!-- 이슈 번호를 작성해주세요 ex) #11 -->

- #이슈번호

## ✅ 작업 사항

- [ ] 작업 내용

## 👩‍💻 공유 포인트 및 논의 사항

0 comments on commit 780baee

Please sign in to comment.