improve issue templates
This commit is contained in:
parent
66a63f654f
commit
c35eb2c13f
24
.github/ISSUE_TEMPLATE/bug_report.md
vendored
24
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,38 +1,38 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
title: "[BUG]"
|
title: "[BUG] "
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**What did you do?**
|
## What did you do
|
||||||
|
|
||||||
- How was the cluster created?
|
- How was the cluster created?
|
||||||
- `k3d cluster create -x A -y B`
|
- `k3d cluster create -x A -y B`
|
||||||
|
|
||||||
- What did you do afterwards?
|
- What did you do afterwards?
|
||||||
- k3d commands?
|
- k3d commands?
|
||||||
- docker commands?
|
- docker commands?
|
||||||
- OS operations (e.g. shutdown/reboot)?
|
- OS operations (e.g. shutdown/reboot)?
|
||||||
|
|
||||||
**What did you expect to happen?**
|
## What did you expect to happen
|
||||||
|
|
||||||
Concise description of what you expected to happen after doing what you described above.
|
Concise description of what you expected to happen after doing what you described above.
|
||||||
|
|
||||||
**Screenshots or terminal output**
|
## Screenshots or terminal output
|
||||||
|
|
||||||
If applicable, add screenshots or terminal output (code block) to help explain your problem.
|
If applicable, add screenshots or terminal output (code block) to help explain your problem.
|
||||||
|
|
||||||
**Which OS & Architecture?**
|
## Which OS & Architecture
|
||||||
|
|
||||||
- Linux, Windows, MacOS / amd64, x86, ...?
|
- Linux, Windows, MacOS / amd64, x86, ...?
|
||||||
|
|
||||||
**Which version of `k3d`?**
|
## Which version of `k3d`
|
||||||
|
|
||||||
- output of `k3d version`
|
- output of `k3d version`
|
||||||
|
|
||||||
**Which version of docker?**
|
## Which version of docker
|
||||||
|
|
||||||
- output of `docker version`
|
- output of `docker version` and `docker info`
|
||||||
|
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,31 +1,31 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest an idea for this project
|
about: Suggest an idea for this project
|
||||||
title: "[FEATURE]"
|
title: "[FEATURE] "
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem or a Pull Request?**
|
## Is your feature request related to a problem or a Pull Request
|
||||||
|
|
||||||
Please link to the issue/PR here and explain how your request is related to it.
|
Please link to the issue/PR here and explain how your request is related to it.
|
||||||
|
|
||||||
**Scope of your request**
|
## Scope of your request
|
||||||
|
|
||||||
Do you need...
|
Do you need...
|
||||||
|
|
||||||
- a new noun (next to e.g. `cluster`, `node`, etc. used via `k3d <noun>`)?
|
- a new noun (next to e.g. `cluster`, `node`, etc. used via `k3d <noun>`)?
|
||||||
- a new verb (next to e.g. `cluster create`, `node start`, etc. used via `k3d <noun> <verb>`)
|
- a new verb (next to e.g. `cluster create`, `node start`, etc. used via `k3d <noun> <verb>`)
|
||||||
- a new flag for a command (e.g. `k3d cluster create --<your-flag>`)?
|
- a new flag for a command (e.g. `k3d cluster create --<your-flag>`)?
|
||||||
- which command?
|
- which command?
|
||||||
- different functionality for an existing command/flag
|
- different functionality for an existing command/flag
|
||||||
- which command or flag?
|
- which command or flag?
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
## Describe the solution you'd like
|
||||||
|
|
||||||
A clear and concise description of what you want to happen.
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
## Describe alternatives you've considered
|
||||||
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
Loading…
Reference in New Issue
Block a user