Skip to content

Commit 9dc59b4

Browse files
rheoneahsteele
authored andcommitted
Add issue templates
include - Bug - Feature Request - Technical Debt - Documentation Request Issues #15
1 parent b4ec4cb commit 9dc59b4

File tree

4 files changed

+135
-0
lines changed

4 files changed

+135
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
# Describe the bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
# Expected behavior
14+
15+
A clear and concise description of what you expected to happen.
16+
17+
# Example of how to Reproduce
18+
19+
Provide the steps to reproduce the behavior by including a code example either inline or via a [Gist](https://gist.github.com/) link.
20+
If a code example is not possible, or too complex for the context of the issue describe in detail
21+
22+
# Environment Information
23+
24+
- Is this issue browser specific?
25+
- What browser was in use?
26+
- What browser version was the issue encountered on?
27+
- What operating system is in use?
28+
- What other libraries are in use? e.g Angular, jQuery, etc.
29+
- What versions?
30+
31+
# Proposed solutions
32+
33+
Do you have a solution that may fix this issue?
34+
35+
# Can you help?
36+
37+
Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
38+
39+
# Additional context
40+
41+
Add any other context about the problem here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Documentation Needed
3+
about: Proposal for additional documentation or examples of code usage
4+
title: "[Doc]"
5+
labels: documentation
6+
assignees: ""
7+
---
8+
9+
# Description
10+
11+
A clear and concise description of what is missing in documentation, or how documentation may be improved.
12+
What failings have occurred due to this lack of information?
13+
14+
# Impact
15+
16+
Description of the current or possible impact of this addition.
17+
18+
# Proposed solutions
19+
20+
Do you have a solution that may fix this issue?
21+
22+
# Can you help?
23+
24+
Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
25+
26+
# Additional context
27+
28+
Add any other context about the problem here.
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature Request]"
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
# Description
10+
11+
A clear and concise description of what the desired feature is.
12+
13+
Is your feature request related to an existing problem? Please describe it and/or provide an issue number.
14+
15+
# Proposed solutions
16+
17+
Do you have a solution, what would you recommend to fix it?
18+
If you don't have a solution what would you like the end result to be?
19+
20+
# Can you help?
21+
22+
Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
23+
24+
# Describe alternatives you've considered
25+
26+
Did you consider any alternatives solutions or features?
27+
Did you have a workaround that met your needs?
28+
29+
# Additional context
30+
31+
Add any other context about the problem here.
+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Technical Debt
3+
about: A better solution for an already solved problem
4+
title: "[TechDebt]"
5+
labels: TechDebt
6+
assignees: ""
7+
---
8+
9+
# Description
10+
11+
A clear and concise description of what the technical debt is, and the reason it should be improved.
12+
13+
# Impact
14+
15+
Description of the current or possible impact of this tech debt. Include both the positive and negative.
16+
17+
## Observations
18+
19+
How would this change make things better?
20+
21+
# Proposed solutions
22+
23+
Do you have a solution that may fix this issue?
24+
25+
# Can you help?
26+
27+
Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
28+
29+
## Related files
30+
31+
- [files](url)
32+
33+
# Additional context
34+
35+
Add any other context about the problem here.

0 commit comments

Comments
 (0)