forked from alshedivat/al-folio
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved issues templates (alshedivat#2110)
Since a lot of issues opened are just questions that should be opened as so, and sometimes the issue template is just not followed, I decided to make opening new issues a little more "enforced", if not clear. I based the new templates on the ones from [pytorch lightning](https://github.com/Lightning-AI/pytorch-lightning/issues/new/choose), which I think are pretty good. The visuals will only appear after the merge is processed, but you can have an idea of how it will look like by checking their templates and how they look. --------- Signed-off-by: George Araújo <george.gcac@gmail.com>
- Loading branch information
1 parent
ee0f965
commit 8a24d03
Showing
5 changed files
with
163 additions
and
65 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,100 @@ | ||
name: 🐛 Report a bug | ||
description: Any errors. | ||
labels: ["needs triage", "bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Before you go any further. Is this really a **🐛 bug**? | ||
If it's a question about how al-folio works, have a look at our [documentation](../../README.md), | ||
[frequently asked questions](../../FAQ.md), [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a), | ||
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a). | ||
- type: checkboxes | ||
id: requirements | ||
attributes: | ||
label: Have you checked that your issue isn't already filed? | ||
description: > | ||
Please check if somebody else has already filed the same issue. | ||
If you find a similar issue, please add a 👍 reaction or comment on the original post. | ||
options: | ||
- label: I read through [FAQ](../../FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue. | ||
required: true | ||
- label: Yes, I have checked that this issue isn't already filed. | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Bug description | ||
description: A description of the 🐛 bug. | ||
placeholder: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: How to reproduce the bug | ||
description: Provide steps to reproduce the 🐛 bug. | ||
placeholder: | | ||
Include steps to reproduce, the expected behaviour, and the actual behaviour. | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Error messages and logs | ||
description: > | ||
Provide any error messages and/or logs | ||
placeholder: "Copy the complete error messages and logs" | ||
value: | | ||
``` | ||
The error message you got, with the full traceback if available. Please paste it between these triple backticks. | ||
``` | ||
validations: | ||
required: false | ||
|
||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: What operating system are you using? | ||
description: select all OSs where you have experienced this issue | ||
multiple: true | ||
options: | ||
- Linux | ||
- Mac | ||
- Windows | ||
- Not applicable (e.g. you're using GitHub Pages or other hosting)0 | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: environment | ||
attributes: | ||
label: Where are you seeing the problem on? | ||
description: select all environments where you have experienced this issue | ||
multiple: true | ||
options: | ||
- "Running locally with Docker" | ||
- "Running locally without Docker" | ||
- "Deployed site" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: More info | ||
description: Add any other info about the issue here. | ||
placeholder: | | ||
Add any other context about the problem here, such as versions of the libraries if running without docker, screenshots, links to the deployed site, etc. | ||
validations: | ||
required: false | ||
|
||
- type: markdown | ||
attributes: | ||
value: "**Happy coding!**" |
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,55 @@ | ||
name: 🚀 Feature request | ||
description: Propose a feature for this project | ||
labels: ["needs triage", "enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Before you go any further, are you sure that this feature is not already implemented? | ||
If it's a question about how al-folio works, have a look at our [documentation](../../README.md), | ||
[frequently asked questions](../../FAQ.md), [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a), | ||
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a). | ||
- type: checkboxes | ||
id: requirements | ||
attributes: | ||
label: Have you checked that your feature request isn't already filed? | ||
description: > | ||
Please check if somebody else has already filed the same 🚀 feature request. | ||
If you find a similar feature request, please add a 👍 reaction or comment on the original post. | ||
options: | ||
- label: I read through [FAQ](../../FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request. | ||
required: true | ||
- label: Yes, I have checked that this feature request isn't already filed. | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description & Motivation | ||
description: A clear and concise description of the 🚀 feature proposal | ||
placeholder: | | ||
Please outline the motivation for the proposal. | ||
Is your feature request related to a problem? e.g., I'm always frustrated when [...]. | ||
If this is related to another GitHub issue, please link it here | ||
- type: textarea | ||
attributes: | ||
label: Pitch | ||
description: A clear and concise description of what you want to happen. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: A clear and concise description of any alternative solutions or features you've considered, if any. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here. | ||
validations: | ||
required: false |
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,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: ❓ Ask a Question | ||
url: https://github.com/alshedivat/al-folio/discussions/categories/q-a | ||
about: Ask and answer al-folio related questions. | ||
- name: 📖 Read the documentation | ||
url: ../../README.md | ||
about: Please consult the documentation before opening any issues! |
This file was deleted.
Oops, something went wrong.