📚 docs(issues): updated the issues templates to be more aligned to each other and be easier to fill
This commit is contained in:
parent
d4d8870a47
commit
c67108cc11
3 changed files with 28 additions and 50 deletions
38
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
38
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
@ -1,7 +1,7 @@
|
||||||
name: "🐛 Bug Report"
|
name: "🐛 Bug Report"
|
||||||
description: Create a bug/issue report
|
description: Create a bug/issue report
|
||||||
title: "🐛 [BUG] - <title>"
|
title: "🐛 Bug: "
|
||||||
labels: ["bug"]
|
labels: [bug]
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -12,31 +12,13 @@ body:
|
||||||
required: true
|
required: true
|
||||||
- label: I have searched the existing issues of used programs related to this issue
|
- label: I have searched the existing issues of used programs related to this issue
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
|
||||||
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: "Description of the bug"
|
label: "Description of the bug"
|
||||||
description: A clear and concise description of what the bug is.
|
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:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
@ -44,17 +26,6 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: "Screenshots"
|
label: "Screenshots"
|
||||||
description: If needed, add screenshots to help explain your problem.
|
description: If needed, add screenshots to help explain your problem.
|
||||||
value: |
|
|
||||||

|
|
||||||
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:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
@ -64,6 +35,5 @@ body:
|
||||||
description: Please add any relevant information about your environment.
|
description: Please add any relevant information about your environment.
|
||||||
value: |
|
value: |
|
||||||
Linux Distro, Linux Version, Hyprland Version...
|
Linux Distro, Linux Version, Hyprland Version...
|
||||||
render: bash
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
|
20
.github/ISSUE_TEMPLATE/documentation_update.yml
vendored
20
.github/ISSUE_TEMPLATE/documentation_update.yml
vendored
|
@ -1,7 +1,7 @@
|
||||||
name: "📚 Documentation Update"
|
name: "📚 Documentation Update"
|
||||||
description: Suggest a new change in the repo documentation
|
description: Suggest a new change in the repo documentation
|
||||||
title: "📚 [DOC UPDATE] - <title>"
|
title: "📚 Docs: "
|
||||||
labels: ["documentation"]
|
labels: [documentation]
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -10,27 +10,31 @@ body:
|
||||||
options:
|
options:
|
||||||
- label: I have searched the existing requests of the repo
|
- label: I have searched the existing requests of the repo
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- label: I have searched the existing requests of used programs related to this request
|
||||||
validations:
|
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Description of the request
|
label: Description of the request
|
||||||
description: A clear description of the documentation update.
|
description: A clear description of the documentation update.
|
||||||
- type: input
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: Current Documentation
|
label: Current Documentation
|
||||||
description: Provide a link to the current documentation or describe where it can be found.
|
description: Provide a link to the current documentation or describe where it can be found.
|
||||||
- type: textarea
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Proposed Documentation
|
label: Proposed Documentation
|
||||||
description: Provide a clear description of the updated documentation.
|
description: Provide a clear description of the updated documentation.
|
||||||
- type: textarea
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional Context
|
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.
|
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
|
||||||
|
|
20
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
20
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
@ -1,7 +1,7 @@
|
||||||
name: "💡 Feature Request"
|
name: "💡 Feature Request"
|
||||||
description: Suggest a new feature request
|
description: Suggest a new feature request
|
||||||
title: "💡 [REQUEST] - <title>"
|
title: "💡 Feature: "
|
||||||
labels: ["enhancement"]
|
labels: [enhancement]
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -10,27 +10,31 @@ body:
|
||||||
options:
|
options:
|
||||||
- label: I have searched the existing requests of the repo
|
- label: I have searched the existing requests of the repo
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- label: I have searched the existing requests of used programs related to this request
|
||||||
validations:
|
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have read the [FAQ](https://github.com/Matt-FTW/dotfiles/blob/main/.github/FAQ.md)
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Is your feature request related to a problem? Please describe.
|
label: Is your feature request related to a problem? Please describe.
|
||||||
description: A clear description of what the problem is.
|
description: A clear description of what the problem is.
|
||||||
- type: textarea
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe the solution you'd like
|
label: Describe the solution you'd like
|
||||||
description: A clear description of what you want to happen.
|
description: A clear description of what you want to happen.
|
||||||
- type: textarea
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe alternatives you've considered
|
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.
|
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:
|
validations:
|
||||||
required: false
|
required: true
|
||||||
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional Context
|
label: Additional Context
|
||||||
description: Add any other context or screenshots about the feature request here. Here you can include issue links if needed.
|
description: Add any other context or screenshots about the feature request here. Here you can include issue links if needed.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
Loading…
Add table
Reference in a new issue