Skip to content

Commit

Permalink
Add issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
JWCook committed Nov 9, 2023
1 parent 2870501 commit b9d6ef6
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F41E Bug report"
about: 'Reporting a bug or other unexpected behavior'
title: ''
labels: bug

---

### The problem
_A description of what the bug is, including a complete traceback (if applicable)_

### Expected behavior
_A description of what you expected to happen_

### Steps to reproduce the behavior
_With a complete code example, if possible_

### Workarounds
_Is there an existing workaround for this issue?_

### Environment
- OS & version: [e.g. Debian 10]
- Python version: [e.g. `3.12`]
- Pyinaturalist-convert version or branch: [e.g. `0.6` or `main` branch]
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "\U0001F680 Feature request"
about: 'Request a new feature or other non-bugfix improvement'
title: 'Feature request:'
labels: enhancement

---

### Feature description

### Use case
_Is there a specific goal that this would help you accomplish, or can you provide any other context about how you would like to use this feature?_

### Workarounds
_Is there an existing workaround to accomplish this?_
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: "\U00002754 Question"
about: 'Question about pyinaturalist-convert'
title: ''
labels: question

---

<!--
Note: For more open-ended questions, please create a new discussion:
https://github.com/orgs/pyinat/discussions
-->
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Closes #<issue number>

<!--
If any of the items below don't apply to your PR, you can just remove them.
See the contributing guide for more info:
https://pyinaturalist.readthedocs.io/en/main/contributing.html
-->
### Checklist
- [ ] Add doctrings + type annotations
- [ ] Verify that docs build correctly in Sphinx
- [ ] Add unit tests for any new/changed behavior
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,6 @@ ta = TaxonAutocompleter()
ta.search('aves')
ta.search('flughund', language='german')
```

# Feedback
If you have any problems, suggestions, or questions about pyinaturalist-convert, you are welcome to [create an issue](https://github.com/pyinat/pyinaturalist-convert/issues/new/choose) or [discussion](https://github.com/orgs/pyinat/discussions). Also, **PRs are welcome!**

0 comments on commit b9d6ef6

Please sign in to comment.