-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add formalized issue template (#417)
- Loading branch information
Showing
2 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
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,40 @@ | ||
name: Bug report | ||
description: Create a bug report to help us to improve | ||
title: "[BUG] ..." | ||
labels: bug | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: | | ||
Briefly describe the problem you are having in a few paragraphs. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Code snippet that reproduces the issue | ||
description: | | ||
Write a runnable code example that reproduces unexpected behavior | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe the results you expected | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Python version you are using | ||
placeholder: python --version | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Environment description | ||
placeholder: python -m pip freeze | ||
validations: | ||
required: true |
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,39 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: "[FEATURE] ..." | ||
labels: enhancement | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Is your feature request related to a problem? Please describe. | ||
value: I'm always frustrated when [...] | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Possible solution | ||
description: | | ||
Describe the solution you'd like. | ||
A clear and concise description of what you want to happen. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: | | ||
Describe alternatives you've considered | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Context | ||
description: | | ||
Additional context | ||
Add any other context or screenshots about the feature request here. | ||
validations: | ||
required: false |