Update Templates for issues

This commit is contained in:
Abdul Rabbani 2022-04-27 09:34:35 -04:00
parent 1a77762c4c
commit f81b6cf25d
3 changed files with 107 additions and 12 deletions

View File

@ -1,11 +1,12 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: "" title: "[Bug]"
labels: "" labels: bug
assignees: "" assignees: ""
--- ---
- [Overview](#overview)
- [Describe the bug](#describe-the-bug) - [Describe the bug](#describe-the-bug)
- [To Reproduce](#to-reproduce) - [To Reproduce](#to-reproduce)
- [Expected behavior](#expected-behavior) - [Expected behavior](#expected-behavior)
@ -16,36 +17,57 @@ assignees: ""
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small> <small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
# Overview
- **Requester**: @ the requestor.
- **Epic Link**: Link the epic.
# Describe the bug # Describe the bug
<!---
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
--->
# To Reproduce # To Reproduce
Steps to reproduce the behavior: Steps to reproduce the behavior:
<!---
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
3. Scroll down to '....' 3. Scroll down to '....'
4. See error 4. See error
--->
# Expected behavior # Expected behavior
<!---
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
--->
# Evidence # Evidence
<!---
Provide any supporting documentation.
--->
## Logs ## Logs
<!---
Provide any logs if applicable. Provide any logs if applicable.
--->
## Screenshots ## Screenshots
<!---
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
--->
# Additional context # Additional context
<!---
Add any other context about the problem here. Add any other context about the problem here.
--->
**Desktop (please complete the following information):** **Desktop (please complete the following information):**

62
.github/ISSUE_TEMPLATE/epic.md vendored Normal file
View File

@ -0,0 +1,62 @@
---
name: Epic
about: Template for creating an Epic
title: "[EPIC]"
labels: epic
assignees: ""
---
- [Overview](#overview)
- [Description](#description)
- [Dependencies](#dependencies)
- [Context](#context)
- [Issues](#issues)
- [Acceptance criteria](#acceptance-criteria)
- [Proof](#proof)
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
# Overview
- **Owner**: @ the owner.
- **Stakeholder Point of Contact**: @ the point of contact.
## Description
<!---
Describe what this epic is supposed to solve.
--->
# Dependencies
<!---
What are the dependencies for this epic.
--->
# Context
<!---
Provide any useful context.
--->
# Issues
<!---
Link any issues
--->
- [ ] Issue one
- [ ] issue two
- [ ] issue three
# Acceptance criteria
<!---
What needs to occur for this to be successful.
--->
## Proof
<!---
Link any PR's, documents, other evidence highlighting that the acceptance criteria were met.
--->

View File

@ -1,11 +1,12 @@
--- ---
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: "" title: "[Feature]"
labels: "" labels: feature
assignees: "" assignees: ""
--- ---
- [Overview](#overview)
- [Request](#request) - [Request](#request)
- [Potential Solution](#potential-solution) - [Potential Solution](#potential-solution)
- [Alternative Solutions](#alternative-solutions) - [Alternative Solutions](#alternative-solutions)
@ -13,18 +14,28 @@ assignees: ""
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small> <small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
# Request # Overview
**Explain what you want and why. If this feature is related to a problem please highlight it here.** - **Requester**: @ the requestor.
- **Epic Link**: Link the epic.
## Potential Solution ## Request
**Provide any details for a potential solution.** <!---
Explain what you want and why. If this feature is related to a problem please highlight it here.**
--->
# Potential Solution
<!---Provide any details for a potential solution.
--->
## Alternative Solutions ## Alternative Solutions
**Provide any alternative solutions.** <!---Provide any alternative solutions.
--->
# Additional Context # Additional Context
**Provide Additional Context.** <!---Provide Additional Context.
--->