📚 docs(issues): updated the issues templates to be more aligned to each other and be easier to fill

This commit is contained in:
Sergio Laín 2024-08-09 01:19:35 +02:00
parent d4d8870a47
commit c67108cc11
No known key found for this signature in database
GPG key ID: 8429B2EE312F8150
3 changed files with 28 additions and 50 deletions

View file

@ -1,7 +1,7 @@
name: "🐛 Bug Report"
description: Create a bug/issue report
title: "🐛 [BUG] - <title>"
labels: ["bug"]
title: "🐛 Bug: "
labels: [bug]
body:
- type: checkboxes
attributes:
@ -12,31 +12,13 @@ body:
required: true
- label: I have searched the existing issues of used programs related to this issue
required: true
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
required: true
- type: textarea
id: description
attributes:
label: "Description of the bug"
description: A clear and concise description of what the bug is.
render: bash
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. And so on...
render: bash
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: textarea
@ -44,17 +26,6 @@ body:
attributes:
label: "Screenshots"
description: If needed, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: textarea
@ -64,6 +35,5 @@ body:
description: Please add any relevant information about your environment.
value: |
Linux Distro, Linux Version, Hyprland Version...
render: bash
validations:
required: false

View file

@ -1,7 +1,7 @@
name: "📚 Documentation Update"
description: Suggest a new change in the repo documentation
title: "📚 [DOC UPDATE] - <title>"
labels: ["documentation"]
title: "📚 Docs: "
labels: [documentation]
body:
- type: checkboxes
attributes:
@ -10,27 +10,31 @@ body:
options:
- label: I have searched the existing requests of the repo
required: true
- type: textarea
validations:
- label: I have searched the existing requests of used programs related to this request
required: true
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
required: true
- type: textarea
attributes:
label: Description of the request
description: A clear description of the documentation update.
- type: input
validations:
required: true
- type: input
attributes:
label: Current Documentation
description: Provide a link to the current documentation or describe where it can be found.
- type: textarea
validations:
required: true
- type: textarea
attributes:
label: Proposed Documentation
description: Provide a clear description of the updated documentation.
- type: textarea
validations:
required: false
required: true
- type: textarea
attributes:
label: Additional Context
description: Add any other information about the documentation update here. For example, you might include links to similar documentation in other projects, or screenshots or diagrams to help explain your idea.
validations:
required: false

View file

@ -1,7 +1,7 @@
name: "💡 Feature Request"
description: Suggest a new feature request
title: "💡 [REQUEST] - <title>"
labels: ["enhancement"]
title: "💡 Feature: "
labels: [enhancement]
body:
- type: checkboxes
attributes:
@ -10,27 +10,31 @@ body:
options:
- label: I have searched the existing requests of the repo
required: true
- type: textarea
validations:
- label: I have searched the existing requests of used programs related to this request
required: true
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear description of what the problem is.
- type: textarea
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear description of what you want to happen.
- type: textarea
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear description of any alternative solutions or features you've considered. Here you can include pull request links if needed.
- type: textarea
validations:
required: false
required: true
- type: textarea
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here. Here you can include issue links if needed.
validations:
required: false