docs: improve issue templates (#1235)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -14,52 +14,65 @@ Please make sure to
|
|||||||
before filing a new one!
|
before filing a new one!
|
||||||
|
|
||||||
Questions labeled with `Optional` can be skipped.
|
Questions labeled with `Optional` can be skipped.
|
||||||
-->
|
|
||||||
|
|
||||||
<!--
|
|
||||||
If you're here to report about a "No asset found" error, please make sure that
|
If you're here to report about a "No asset found" error, please make sure that
|
||||||
an hour has been passed since the last release was made.
|
an hour has been passed since the last release was made.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] I have searched the issue tracker for relevant or duplicate issues.
|
||||||
|
|
||||||
## Erroneous Behavior
|
## Erroneous Behavior
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
What actually happened?
|
What actually happened?
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Expected Behavior
|
## Expected Behavior
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Describe the expected behavior
|
Describe the expected behavior.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Steps to reproduce
|
## Steps to reproduce
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
A minimal example to reproduce the issue
|
A minimal example to reproduce the issue.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Possible Cause (Optional)
|
## Possible Cause (Optional)
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
If you know the possible cause of the issue, please tell us.
|
If you know the possible cause of the issue, please tell us.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Problem persists without calling from topgrade
|
## Problem persists without calling from topgrade
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Execute the erroneous command directly to see if the problem persists
|
Execute the erroneous command directly to see if the problem persists.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
- [ ] Yes
|
- [ ] Yes
|
||||||
- [ ] No
|
- [ ] No
|
||||||
|
|
||||||
## Did you run topgrade through `Remote Execution`
|
## Ran through `Remote Execution`
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Did you run topgrade through `Remote Execution`?
|
||||||
|
-->
|
||||||
|
|
||||||
- [ ] Yes
|
- [ ] Yes
|
||||||
- [ ] No
|
- [ ] No
|
||||||
|
|
||||||
If yes, does the issue still occur when you run topgrade directly in your
|
If yes, does the issue still occur when you run topgrade directly in your
|
||||||
remote host
|
remote host?
|
||||||
|
|
||||||
- [ ] Yes
|
- [ ] Yes
|
||||||
- [ ] No
|
- [ ] No
|
||||||
|
|
||||||
## Configuration file (Optional)
|
## Configuration file (Optional)
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Paste your configuration file inside the code block if you think this issue is
|
Paste your configuration file inside the code block if you think this issue is
|
||||||
related to configuration.
|
related to configuration.
|
||||||
@@ -70,6 +83,7 @@ related to configuration.
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Additional Details
|
## Additional Details
|
||||||
|
|
||||||
- Operation System/Version
|
- Operation System/Version
|
||||||
<!-- For example, Fedora Linux 38 -->
|
<!-- For example, Fedora Linux 38 -->
|
||||||
|
|
||||||
@@ -82,6 +96,7 @@ related to configuration.
|
|||||||
- Topgrade version (`topgrade -V`)
|
- Topgrade version (`topgrade -V`)
|
||||||
|
|
||||||
## Verbose Output (`topgrade -v`)
|
## Verbose Output (`topgrade -v`)
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Paste the verbose output into the pre-tags
|
Paste the verbose output into the pre-tags
|
||||||
-->
|
-->
|
||||||
|
|||||||
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,21 +1,15 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: General feature request
|
||||||
about: Can you please support...?
|
about: Suggest a general feature, or feature within an already existing step
|
||||||
title: ''
|
title: ''
|
||||||
labels: 'C-feature request'
|
labels: C-feature request
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## I want to suggest a new step
|
## Checklist
|
||||||
|
|
||||||
* Which tool is this about? Where is its repository?
|
- [ ] I have searched the issue tracker for relevant or duplicate issues.
|
||||||
* Which operating systems are supported by this tool?
|
|
||||||
* What should Topgrade do to figure out if the tool needs to be invoked?
|
|
||||||
* Which exact commands should Topgrade run?
|
|
||||||
* Does it have a `--dry-run` option? i.e., print what should be done and exit
|
|
||||||
* Does it need the user to confirm the execution? And does it provide a `--yes`
|
|
||||||
option to skip this step?
|
|
||||||
|
|
||||||
## I want to suggest some general feature
|
## I want to suggest some general feature
|
||||||
|
|
||||||
@@ -25,3 +19,5 @@ Topgrade should...
|
|||||||
|
|
||||||
<!-- Assuming that someone else implements the feature,
|
<!-- Assuming that someone else implements the feature,
|
||||||
please state if you know how to test it from a side branch of Topgrade. -->
|
please state if you know how to test it from a side branch of Topgrade. -->
|
||||||
|
|
||||||
|
- [ ] I am able and willing to implement this feature myself
|
||||||
|
|||||||
29
.github/ISSUE_TEMPLATE/step_request.md
vendored
Normal file
29
.github/ISSUE_TEMPLATE/step_request.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
---
|
||||||
|
name: New step request
|
||||||
|
about: Suggest a new step/package manager to update
|
||||||
|
title: ''
|
||||||
|
labels: C-feature request, request step
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] I have searched the issue tracker for relevant or duplicate issues.
|
||||||
|
|
||||||
|
## I want to suggest a new step
|
||||||
|
|
||||||
|
* Which tool is this about? Where is its repository?
|
||||||
|
* Which operating systems are supported by this tool?
|
||||||
|
* What should Topgrade do to figure out if the tool needs to be invoked?
|
||||||
|
* Which exact commands should Topgrade run?
|
||||||
|
* Does it have a `--dry-run` option? i.e., print what should be done and exit
|
||||||
|
* Does it need the user to confirm the execution? And does it provide a `--yes`
|
||||||
|
option to skip this?
|
||||||
|
|
||||||
|
## More information
|
||||||
|
|
||||||
|
<!-- Assuming that someone else implements the step,
|
||||||
|
please state if you know how to test it from a side branch of Topgrade. -->
|
||||||
|
|
||||||
|
- [ ] I am able and willing to implement this step myself
|
||||||
Reference in New Issue
Block a user