Skip to content

Commit 0c0c6dc

Browse files
authored
Create issue templates (#326)
# Purpose Closes #325. Github supports multiple issue and PR templates: https://github.blog/news-insights/product-news/multiple-issue-and-pull-request-templates/ # New Changes - Created an issue for features - Created an issue for bugs # Testing No testing is required # Outstanding Changes - Create issues based on these templates - Update the PR template to reflect changes to using GH projects
1 parent 9e5f756 commit 0c0c6dc

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

.github/ISSUE_TEMPLATES/bugs.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Expected Behavior
2+
<!--- If you're describing a bug, tell us what should happen -->
3+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
4+
5+
## Current Behavior
6+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
7+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
8+
9+
## Possible Solution
10+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
11+
<!--- or ideas how to implement the addition or change -->
12+
13+
## Steps to Reproduce (for bugs)
14+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
15+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
16+
1.
17+
2.
18+
3.
19+
4.
20+
21+
## Context
22+
<!--- How has this issue affected you? What are you trying to accomplish? -->
23+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
24+
25+
## Your Environment
26+
<!--- Include as many relevant details about the environment you experienced the bug in -->

.github/ISSUE_TEMPLATES/feature.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Background
2+
<!-- Explain the purpose of the feature and the context in which it will be used -->
3+
<!-- Link to an issue or PR that describes the feature in more detail, if applicable. -->
4+
5+
## Requirements
6+
<!-- Describe the requirements that this feature must meet. -->
7+
- [ ] Requirement 1
8+
9+
## Important Info
10+
<!-- Additional important information such as links to resources. -->
11+
-
12+

0 commit comments

Comments
 (0)