Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
-Add "chore"
-Update templates to have a progress checklist
  • Loading branch information
e-lo committed Apr 28, 2022
1 parent 12c745d commit 4950f28
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 12 deletions.
18 changes: 12 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] Description of problem"
title: "🐛 Bug: "
labels: bug
assignees: ''

---

## Describe the bug
A clear and concise description of what the bug is or the error code you got. e.g.
<!--A clear and concise description of what the bug is or the error code you got. e.g.
```python
KeyError: 'Passing list-likes to .loc or [] with any missing labels is no longer supported, see https://pandas.pydata.org/pandas-docs/stable/user_guide/indexing.html#deprecate-loc-reindex-listlike'
```
-->

Progress:

- [ ] Sufficient information provided
- [ ] Cause identified/found
- [ ] Test developed/identified
- [ ] Approach determined
- [ ] Test passes

## To Reproduce
Steps to reproduce the behavior:
Expand All @@ -22,16 +30,14 @@ Steps to reproduce the behavior:

### Failing tests
- [ ] No applicable test failed, need to create.
- [ ]
- [ ] other...specify

### Triggering line of code


### Thoughts on resolution

### Full stack trace


### Environment

Operating system:
Expand Down
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/chore_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Chore
about: Something that isn't a feature or a bug
title: "🧹 Chore: "
labels: chore
assignees: ''
---

<!--Short Description-->

Progress:

- [ ] Sufficiently defined
- [ ] Approach decided
- [ ] Implemented

## Considerations
<!--Short Description-->
25 changes: 19 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
about: Suggest an enhancement
title: "🚀 Feature:"
labels: enhancement
assignees: ''

---

### User Story
*As a ...insert type of user... I'd like to ...insert desired feature or behavior...*

<<<<<<< Updated upstream
- [ ] Requirement sufficiently defined
- [ ] Approach determined
- [ ] User story satisfied
- [ ] Doc strings
- [ ] General documentation
- [ ] Tests
=======
Progress:

- [ ] Sufficiently defined
- [ ] Approach determined
- [ ] Tests developed
- [ ] User story satisfied
- [ ] Doc strings
- [ ] General documentation
>>>>>>> Stashed changes
- [ ] Passing tests

### Priority
Expand All @@ -25,17 +34,21 @@ assignees: ''
### Resolution Ideas

### Project
*Is there a funder or project associated with this feature?*
<!--Is there a funder or project associated with this feature?-->

### Who should be involved?
Users:
Reviewers:

### Risk
*Will this potentially break anything?*
<!--Will this potentially break anything?-->

#### Tests
<<<<<<< Updated upstream
*What are relevant tests or what tests need to be created in order to determine that this issue is complete?*

- [ ] Test for...

=======
<!--What are relevant tests or what tests need to be created in order to determine that this issue is complete?-->
>>>>>>> Stashed changes

0 comments on commit 4950f28

Please sign in to comment.