docs(ISSUE_TEMPLATE): added
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
name: 🐞 Bug report
|
||||
description: Report an issue (Something not working? Something went wrong? Report it here!)
|
||||
labels: [bug/pending-triage]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
|
||||
placeholder: Bug description
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: system-info
|
||||
attributes:
|
||||
label: System Info
|
||||
description: Output of `npx envinfo --system --binaries --browsers`
|
||||
render: Shell
|
||||
placeholder: System, Binaries, Browsers
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: checkboxes
|
||||
attributes:
|
||||
label: Validations
|
||||
description: Before submitting the issue, please make sure you do the following
|
||||
options:
|
||||
- label: Follow our [Code of Conduct](https://github.com/moeru-ai/airi/blob/main/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
- label: Read the [Contributing Guide](https://github.com/moeru-ai/airi/blob/main/CONTRIBUTING.md).
|
||||
required: true
|
||||
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
|
||||
required: true
|
||||
- label: Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: contributions
|
||||
attributes:
|
||||
label: Contributions
|
||||
description: Please note that Open Source projects are maintained by volunteers, where your cases might not be always relevant to the others. It would make things move faster if you could help investigate and propose solutions.
|
||||
options:
|
||||
- label: I am willing to submit a PR to fix this issue
|
||||
- label: I am willing to submit a PR with failing tests (actually just go ahead and do it, thanks!)
|
||||
@@ -0,0 +1,42 @@
|
||||
name: 🚀 New feature proposal
|
||||
description: Propose a new feature (Something you would like to see in this project?)
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for your interest in the project and taking the time to fill out this feature report!
|
||||
- type: textarea
|
||||
id: feature-description
|
||||
attributes:
|
||||
label: Clear and concise description of the problem
|
||||
description: 'As a developer using this project I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: suggested-solution
|
||||
attributes:
|
||||
label: Suggested solution / Ideas
|
||||
description: 'In module [xy] we could provide following implementation...'
|
||||
- type: textarea
|
||||
id: alternative
|
||||
attributes:
|
||||
label: Alternative
|
||||
description: Clear and concise description of any alternative solutions or features you've considered.
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Any other context or screenshots about the feature request here.
|
||||
- type: checkboxes
|
||||
id: checkboxes
|
||||
attributes:
|
||||
label: Validations
|
||||
description: Before submitting the issue, please make sure you do the following
|
||||
options:
|
||||
- label: Follow our [Code of Conduct](https://github.com/moeru-ai/airi/blob/main/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
- label: Read the [Contributing Guide](https://github.com/moeru-ai/airi/blob/main/CONTRIBUTING.md).
|
||||
required: true
|
||||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
|
||||
required: true
|
||||
@@ -0,0 +1,15 @@
|
||||
name: 👀 Typo / Grammar fix
|
||||
description: You can just go ahead and send a PR! Thank you!
|
||||
labels: [documentation]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## PR Welcome!
|
||||
|
||||
If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
|
||||
If you spot multiple of them, we suggest combining them into a single PR. Thanks!
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
Reference in New Issue
Block a user