Provide suggestion for some fields in bug report
This commit adds suggestion for some of the required fields because there can be a few exceptions in which these values can not be provided. For example when the `flux` binary can not be installed, or the set of controllers has been installed with just an `install.yaml` file. We use this approach instead of making the fields optional because it guides people to provide the information whenever they can, which should result in higher quality bug reports. As a tiny addition, the reference to "Flux v2" has been renamed to just "Flux" as we are slowly transitioning "Flux v1" into "Flux Legacy". Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
7
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
7
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
description: Create a report to help us improve Flux v2
|
description: Create a report to help us improve Flux
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
@@ -41,20 +41,21 @@ body:
|
|||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: OS / Distro
|
label: OS / Distro
|
||||||
|
description: The OS / distro you are executing `flux` on. If not applicable, write `N/A`.
|
||||||
placeholder: e.g. Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
|
placeholder: e.g. Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
|
||||||
- type: input
|
- type: input
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: Flux version
|
label: Flux version
|
||||||
description: Run `flux --version` to check.
|
description: Run `flux --version` to check. If not applicable, write `N/A`.
|
||||||
placeholder: e.g. 0.16.1
|
placeholder: e.g. 0.16.1
|
||||||
- type: textarea
|
- type: textarea
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: Flux check
|
label: Flux check
|
||||||
description: Run `flux check` to check.
|
description: Run `flux check` to check. If not applicable, write `N/A`.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
For example:
|
For example:
|
||||||
► checking prerequisites
|
► checking prerequisites
|
||||||
|
|||||||
Reference in New Issue
Block a user