Skip to content

Commit

Permalink
Update issue templates. skip ci
Browse files Browse the repository at this point in the history
  • Loading branch information
e-lo committed Oct 28, 2024
1 parent 6b6e4ce commit 653cad2
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 14 deletions.
15 changes: 6 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: "🪲 [BUG] Description of problem"
title: "🪲 "
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'
```
-->

### Thoughts on resolution

## To Reproduce

Steps to reproduce the behavior:
<!-- What are the steps to reproduce the behavior -->

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Failing tests

Expand All @@ -31,8 +30,6 @@ Steps to reproduce the behavior:

### Triggering line of code

### Thoughts on resolution

### Full stack trace

### Environment
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: Chore
about: Something that just has to get done.
title: "🧹 [CHORE]"
title: "🧹 "
labels: chore
assignees: ''

---

What has to get done and why?
<!-- What has to get done and why? -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Documentation
about: Something needs to be better-documented
title: "📘 "
labels: docs
assignees: ''

---

<!--What would you like documented?--->
14 changes: 11 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Feature request
about: Suggest an idea for this project
title: "🚀 [FEATURE]"
title: "🚀 "
labels: enhancement
assignees: ''

Expand All @@ -11,15 +11,23 @@ assignees: ''

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

### What Happens Now

### Resolution Ideas

<!-- Describe what you'd like it to look like -->

### Priority

<!-- Use Low/Medium/High -->

### Level of Effort

### Resolution Ideas
<!-- Use tee-shirt-sizing: S/M/L/XL -->

### 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?

Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Performance
about: Something is agonizingly slow
title: "⏱️ "
labels: performance
assignees: ''

---

### Existing Performance

<!--How long does it take. Provide relevant data and version.--->

### Desired Performance

<!--What is a reasonable target for improvement?--->

### Thoughts on Resolution

<!--Do you have thoughts on how this should be addressed?--->

### Relevant Benchmarks

<!--Ideally any performance issues should be benchmarked in `tests/test_benchmarks.py`--->

0 comments on commit 653cad2

Please sign in to comment.