Skip to content

Commit

Permalink
issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
Filimoa committed Apr 10, 2024
1 parent b649caf commit 5091d28
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 🐛 Openparse Bug
description: Report a bug or unexpected behavior in Openparse
labels: [bug, pending]

body:
- type: markdown
attributes:
value: Thank you for contributing to open-parse! ✊

- type: checkboxes
id: checks
attributes:
label: Initial Checks
description: Just making sure you're using the latest version
options:
- label: I confirm that I'm on the latest version
required: true

- type: textarea
id: description
attributes:
label: Description
description: |
Please explain what you're seeing and what you would expect to see.
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
validations:
required: true

- type: textarea
id: example
attributes:
label: Example Code
description: >
If applicable, please add a self-contained,
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
demonstrating the bug.
placeholder: |
import openparse
...
render: Python

- type: textarea
id: version
attributes:
label: Python, OpenParse & OS Version
description: |
Which version of Python & openparse are you using, and which Operating System?
Please run the following command and copy the output below:
```bash
python -c "import openparse.version; print(openparse.version.version_info())"
```
render: Text
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Ask a Question
url: "https://github.com/Filimoa/open-parse/discussions/new?category=question"
about: Ask a question about how to use openparse using github discussions
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: 🚀 Open-Parse Feature request
description: "Suggest a new feature for open-parse"
labels: [feature request]

body:
- type: markdown
attributes:
value: Thank you for contributing to open-parse! ✊

- type: textarea
id: description
attributes:
label: Description
description: |
Please give as much detail as possible about the feature you would like to suggest. 🙏
You might like to add:
* Your use case(s) for the feature
* Why the feature should be added to openparse (as opposed to another library or just implemented in your code)
validations:
required: true

0 comments on commit 5091d28

Please sign in to comment.