Skip to content

Commit a114dc5

Browse files
authored
Update ISSUE_TEMPLATE.md
1 parent c28d58f commit a114dc5

1 file changed

Lines changed: 23 additions & 10 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
<!---
2-
Thanks for contributing your input! Instructions are in comments, like this
3-
-->
2+
Thanks for contributing your input! Instructions are in comments
43
5-
_please edit this template before submitting a new issue_
4+
comments are between <!--- and --->
65

7-
<!---
6+
7+
_PLEASE USE THIS TEMPLATE when submitting a new issue_
8+
9+
<!--- (REQUIRED)
810
Title: Provide a general summary of your feature / question / issue in the title above.
911
-->
1012

1113
<!---
1214
Tags: please select one or more relevant tags
1315
--->
1416

15-
### Description
17+
### Description (REQUIRED)
1618
<!---
1719
Is there something you want to do? Is this a bug? Feature request? Discussion?
1820
* Question: ask away!
@@ -22,19 +24,30 @@ Is there something you want to do? Is this a bug? Feature request? Discussion?
2224

2325
<!---
2426
### Details
27+
28+
USE CASES: "As an _state role_ I would like to _state what you wish to do_ "
29+
2530
How would this change help? (you, the project, the user community?
2631
How would it be used?
27-
Are there any examples (existing software / utilities)? Please provide links, screenshots, etc-->
32+
Are there any examples (existing software / utilities)? Please provide reproducible code snippets, links, screenshots, etc
2833
29-
### Completion Criteria
34+
-->
35+
### Completion Criteria (REQUIRED/ESSENTIAL)
3036

3137
<!--- How will we know when this is done?
32-
please use boxes like
33-
for a bug:
38+
39+
Examples:
40+
41+
FOR A BUG:
3442
* [ ] Now I can [topic of question / bug]
35-
for a discussion:
43+
44+
FOR A DISCUSSION:
3645
* [ ] Discuss and develop requirements docs; create issues for next steps
3746
for a new feature
47+
* [ ] Create follow up epic / issues
48+
49+
50+
FOR A FEATURE REQUEST
3851
* [ ] create algorithm
3952
* [ ] write test
4053
* [ ] add to pipeline

0 commit comments

Comments
 (0)