🚸 better issue templates

This commit is contained in:
Axel Olausson Holtenäs 2022-06-12 13:09:00 +02:00
parent 7d02cf9b8d
commit eb2ead393a
No known key found for this signature in database
GPG key ID: 7BF6826B76382CBA
4 changed files with 108 additions and 52 deletions

View file

@ -1,32 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: "bug"
assignees: "VermiumSifell"
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):**
- Commit: [git rev-parse HEAD]
- Branch: [git branch --show-current]
**Additional context**
Add any other context about the problem here.

60
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View file

@ -0,0 +1,60 @@
name: 🐞 Bug
description: File a bug/issue
title: "[BUG]: <short_description_of_issue>"
labels: ["bug"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. Run '...'
3. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Node**: 13.14.0
- **npm**: 7.6.3
- **xyter**: 7d02cf9
value: |
- OS: `lsb_release -d`
- Node: `node -v`
- npm: `npm -v`
- xyter: `git rev-parse --short HEAD`
render: markdown
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

View file

@ -0,0 +1,48 @@
name: 🤖 Request a new command
description: Suggest an command for this project
title: "[New Command]: /<command category> [command_group] <command_name> "
labels: ["enhancement", "new-command"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! We will use `/manage credits give` as an example for our placeholders.
- type: input
id: category
attributes:
label: Category
description: Where should we put this command?
placeholder: ex. manage
validations:
required: true
- type: input
id: group
attributes:
label: Group
description: Does this command belong to this group?
placeholder: ex. credits
- type: input
id: command
attributes:
label: Command
description: What should we call this command?
placeholder: ex. give
validations:
required: true
- type: textarea
id: description
attributes:
label: What should the command do?
description: Please tell us your concept, how it should work, and if there should be any additional features.
placeholder: "I would like to have a command to give users credits, that would make it easier for me to administrate credits! I would like it to add a specified amount of credits to specified user, without taking credits from the executer. Command should require Manage Guild permission. When successful, it should return something like: Added <amount> credits to <user>!"
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true

View file

@ -1,20 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'enhancement'
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.