mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-14 16:37:16 +00:00
github: try new issue form template (#758)
Trying out Github's new issue form for bug reports. If it doesn't look good or go well I'll revert.
This commit is contained in:
Clement Tsang
GitHub
parent
4ca68b621d
commit
f0ace2588e
4 changed files with 117 additions and 49 deletions
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Found a bug? Make sure it hasn't already been filed/solved - if so, please report it!
|
||||
title: ""
|
||||
labels: "bug"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems) to see if your problem is already reported/known/fixed.
|
||||
|
||||
If you just have a question, or want to troubleshoot something that you don't think is a bug, feel free to [open a discussion](https://github.com/ClementTsang/bottom/discussions/new).
|
||||
|
||||
Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed!
|
||||
|
||||
## Describe the bug
|
||||
|
||||
Give a high level description of the bug.
|
||||
|
||||
## What operating system/architecture are you using?
|
||||
|
||||
Please mention what operating system, version, and architecture you're experiencing the problem on (ex: macOS 10.13, x86_64). Please also ensure that your system is [on the list of supported systems](https://github.com/ClementTsang/bottom#support) - bug reports on unsupported systems are likely to be closed.
|
||||
|
||||
## What terminal are you using `bottom` on?
|
||||
|
||||
Please mention what terminal/terminal emulator you are using `bottom` on (ex: Konsole, Kitty), as well as their version and any relevant settings.
|
||||
|
||||
## What version are you on?
|
||||
|
||||
Please mention which version of bottom you're running (`btm -V`, nightly, etc.)!
|
||||
|
||||
## How did you install `bottom`?
|
||||
|
||||
Please mention how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_.
|
||||
|
||||
**Note: if you installed from cargo, ensure you installed the right crate (https://crates.io/crates/bottom).**
|
||||
|
||||
## How can we reproduce this?
|
||||
|
||||
Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as possible. Include config files or flags if relevant. If maintainers cannot reproduce the bug, it will be very hard to fix it.
|
||||
|
||||
## What is the actual behaviour?
|
||||
|
||||
What is the _actual_ result of the given steps? Be detailed. Please include screenshots if relevant and possible.
|
||||
|
||||
## What is the expected behaviour?
|
||||
|
||||
What do you believe the expected behaviour should be given these steps?
|
||||
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
116
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
name: Bug report
|
||||
description: Found something wrong or broken? If it hasn't already been filed/solved, report it!
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: acknowledgements
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: >
|
||||
I've looked through:
|
||||
- [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting)
|
||||
- [Known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems)
|
||||
- [Existing issues](https://github.com/ClementTsang/bottom/issues)
|
||||
for similar issues.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Describe the issue
|
||||
description: >
|
||||
Give a high level description of the issue, the expected behaviour, and the observed behaviour.
|
||||
If possible, provide screenshots.
|
||||
placeholder: >
|
||||
Example:
|
||||
bottom is failing to output information for a mounted encrypted partition on basic mode. It should
|
||||
be able to report this information, but I'm not seeing the entry at all.
|
||||
|
||||
- type: dropdown
|
||||
id: operating_system
|
||||
attributes:
|
||||
label: What operating system are you using?
|
||||
description: >
|
||||
Please select the operating system(s) that are experiencing the described issue.
|
||||
multiple: true
|
||||
options:
|
||||
- Linux
|
||||
- macOS
|
||||
- Windows
|
||||
- "Other (please specify in description)"
|
||||
|
||||
- type: dropdown
|
||||
id: architecture
|
||||
attributes:
|
||||
label: What architecture are you using?
|
||||
description: >
|
||||
Please select the architecture(s) that are experiencing the described issue.
|
||||
Note that systems that [are not officially supported](https://github.com/ClementTsang/bottom#support)
|
||||
may not be resolved.
|
||||
multiple: true
|
||||
options:
|
||||
- x86_64 / AMD64
|
||||
- arm64
|
||||
- arm32
|
||||
- x86
|
||||
- Other (please specify in description)
|
||||
|
||||
- type: textarea
|
||||
id: terminal
|
||||
attributes:
|
||||
label: What terminal(s) are you running `bottom` on?
|
||||
description: >
|
||||
Please provide what terminal(s) you are running `bottom` on (e.g. Konsole, kitty)
|
||||
that are experiencing the issue, as well as their version and any relevant settings.
|
||||
placeholder: kitty 0.25.2
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: What version of `bottom` are you running?
|
||||
description: >
|
||||
Please provide which version of `bottom` you're running, which you can find with `btm -V`. If you are using
|
||||
a nightly/non-release version, please also specify that here.
|
||||
placeholder: btm 0.6.8
|
||||
|
||||
- type: input
|
||||
id: install
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: How did you install `bottom`?
|
||||
description: >
|
||||
Please mention how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_.
|
||||
|
||||
**Note: if you installed from `bottom` from cargo, please ensure that you installed the right crate (https://crates.io/crates/bottom).**
|
||||
placeholder: Installed bottom through the Arch official repos.
|
||||
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: How can we reproduce this?
|
||||
description: >
|
||||
Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as
|
||||
possible. Include config files or flags if relevant. If possible, provide screenshots.
|
||||
|
||||
Remember - if maintainers cannot reproduce the issue, it will be very hard to fix!
|
||||
placeholder: >
|
||||
Example:
|
||||
1. Mount a LUKS encrypted partition.
|
||||
2. Run `btm --basic`
|
||||
3. Observe there is no partition shown.
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Provide any additional information you think may be relevant or helpful.
|
||||
placeholder: It works fine if I just run it normally (`btm`).
|
||||
1
.github/ISSUE_TEMPLATE/feature_request.md
vendored
1
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -13,4 +13,3 @@ Try to be clear and concise - more details are usually helpful, but don't ramble
|
|||
|
||||
Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/),
|
||||
or if there's already an issue opened that covers this specific feature.
|
||||
|
||||
|
|
|
|||
2
.github/ISSUE_TEMPLATE/packaging.md
vendored
2
.github/ISSUE_TEMPLATE/packaging.md
vendored
|
|
@ -14,7 +14,7 @@ What is the packaging-related issue? Please be clear and concise.
|
|||
|
||||
- If the issue is specifically about an existing package/distribution, please be aware that the maintainers of this project only
|
||||
manage the distributions of bottom on:
|
||||
|
||||
|
||||
- crates.io
|
||||
- Chocolatey
|
||||
- Binary releases on GitHub
|
||||
|
|
|
|||
Loading…
Reference in a new issue