Skip to content

Commit

Permalink
Update issue templates (#675)
Browse files Browse the repository at this point in the history
Added issue template for bug reports and feature request.
  • Loading branch information
LucaMarconato committed Aug 13, 2024
1 parent a2c2a4b commit d463376
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Recommendation: attach a minimal working example**
Generally, the easier it is for us to reproduce the issue, the faster we can work on it. It is not required, but if you can, please:

1. Reproduce using the [`blobs` dataset](https://spatialdata.scverse.org/en/latest/generated/spatialdata.datasets.blobs.html)
```python
from spatialdata.datasets import blobs
sdata = blobs()
```
You can also use [`blobs_annotating_element`](https://spatialdata.scverse.org/en/latest/generated/spatialdata.datasets.blobs_annotating_element.html) for more control:
```
from spatialdata.datasets import blobs_annotating_element
sdata = blobs_annotating_element('blobs_labels')
```
2. If the above is not possible, reproduce using a public dataset and explain how we can download the data.
3. If the data is private, consider sharing an anonymized version/subset via a [Zulip private message](https://scverse.zulipchat.com/#user/480560), or provide screenshots/GIFs showing the behavior.

**Describe the bug**
A clear and concise description of what the bug is; please report only one bug per issue.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (optional):**
- OS: [e.g. macOS, Windows, Linux]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit d463376

Please sign in to comment.