Skip to content

Commit

Permalink
Add issue templates (bug, small feature, epic)
Browse files Browse the repository at this point in the history
  • Loading branch information
DinaBelova authored and Kshatrix committed Dec 18, 2024
1 parent 3e20b8a commit 60a6edc
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: "[bug] <your bug title here>"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. <step 1>
2. <step 2>
3. <step 3>

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

**Additional context**
Add any other context about the problem here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Epic
about: Feature request that is larger body of work
title: ''
labels: epic
assignees: ''

---

**Goals**
<business / project goals>

**Major deliverables**
<short description of the deliverables>

**Who it benefits**
<describe groups / target audience and what are the benefits of feature implementation for them>

**Acceptance criteria**
- <acc criterion 1>
- <acc criterion 2>
- <acc criterion 3>

**Telemetry & Success Criteria**
<is any telemetry data needed? If yes, what is it?>

**Assumptions**
<any assumptions that are taken into account>

**Limitations**
<list of limitations>

**Out of scope**
<clear description of what is out of scope>

**User stories**
<list of user stories>
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[enhancement] <your feature request title>"
labels: enhancement
assignees: ''

---

**Is your enhancement / feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit 60a6edc

Please sign in to comment.