From c35eb2c13fd3f514536a7914b48385b1607163f0 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Sun, 20 Sep 2020 17:43:04 +0200 Subject: [PATCH] improve issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 24 +++++++++++------------ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 26df3325..932ad2a7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,38 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG]" +title: "[BUG] " labels: bug assignees: '' --- -**What did you do?** +## What did you do - How was the cluster created? - - `k3d cluster create -x A -y B` + - `k3d cluster create -x A -y B` - What did you do afterwards? - - k3d commands? - - docker commands? - - OS operations (e.g. shutdown/reboot)? + - k3d commands? + - docker commands? + - 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. -**Screenshots or terminal output** +## Screenshots or terminal output 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, ...? -**Which version of `k3d`?** +## Which version of `k3d` - output of `k3d version` -**Which version of docker?** +## Which version of docker -- output of `docker version` +- output of `docker version` and `docker info` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 82215485..a3750e97 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,31 +1,31 @@ --- name: Feature request about: Suggest an idea for this project -title: "[FEATURE]" +title: "[FEATURE] " labels: enhancement 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. -**Scope of your request** +## Scope of your request Do you need... - a new noun (next to e.g. `cluster`, `node`, etc. used via `k3d `)? - a new verb (next to e.g. `cluster create`, `node start`, etc. used via `k3d `) - a new flag for a command (e.g. `k3d cluster create --`)? - - which command? + - which command? - 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. -**Describe alternatives you've considered** +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.