-
Notifications
You must be signed in to change notification settings - Fork 463
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Updated CONTRIBUTING and issue templates (#560)
* docs: Updated CONTRIBUTING * chore: Updated bug report template * chore: Added feature request template * chore: Added link to Github discussions for usage questions * chore: Updated bug report into issue form * docs: Added Mindee community invitation in CONTRIBUTING
- Loading branch information
Showing
5 changed files
with
116 additions
and
58 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: 🐛 Bug report | ||
description: Create a report to help us improve the library | ||
labels: bug | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
#### Before reporting a bug, please check that the issue hasn't already been addressed in [the existing and past issues](https://github.com/mindee/doctr/issues?q=is%3Aissue). | ||
- type: textarea | ||
attributes: | ||
label: Bug description | ||
description: | | ||
A clear and concise description of what the bug is. | ||
Please explain the result you observed and the behavior you were expecting. | ||
placeholder: | | ||
A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Code snippet to reproduce the bug | ||
description: | | ||
Sample code to reproduce the problem. | ||
Please wrap your code snippet with ```` ```triple quotes blocks``` ```` for readability. | ||
placeholder: | | ||
```python | ||
Sample code to reproduce the problem | ||
``` | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Error traceback | ||
description: | | ||
The error message you received running the code snippet, with the full traceback. | ||
Please wrap your error message with ```` ```triple quotes blocks``` ```` for readability. | ||
placeholder: | | ||
``` | ||
The error message you got, with the full traceback. | ||
``` | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: | | ||
Please run the following command and paste the output below. | ||
```sh | ||
wget https://raw.githubusercontent.com/mindee/doctr/main/scripts/collect_env.py | ||
# For security purposes, please check the contents of collect_env.py before running it. | ||
python collect_env.py | ||
``` | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Thanks for helping us improve the library! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Usage questions | ||
url: https://github.com/mindee/doctr/discussions | ||
about: Ask questions and discuss with other docTR community members |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: 🚀 Feature request | ||
description: Submit a proposal/request for a new feature for docTR | ||
labels: enhancement | ||
|
||
body: | ||
- type: textarea | ||
attributes: | ||
label: 🚀 The feature | ||
description: > | ||
A clear and concise description of the feature proposal | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Motivation, pitch | ||
description: > | ||
Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: > | ||
A description of any alternative solutions or features you've considered, if any. | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: > | ||
Add any other context or screenshots about the feature request. | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Thanks for contributing 🎉 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters