From ade7fb0759f8796f55a464adc06cc15804c71d80 Mon Sep 17 00:00:00 2001 From: Liz Rice <liz@lizrice.com> Date: Mon, 22 Feb 2021 09:00:59 +0000 Subject: [PATCH] chore: improve bug report template (#821) Ask for more details that we usually need to request anyway, like the list of currently running processes Signed-off-by: Liz Rice <liz@lizrice.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e0f4ae5..724864e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,15 +3,35 @@ name: Bug report about: Tell us about a problem you are experiencing --- -**What steps did you take and what happened:** +**Overview** -[A clear and concise description of what the bug is, and what commands you ran. If possible please supply logs generated with the `-v 3` parameter.) +[A clear and concise description of what the bug is] + +**How did you run kube-bench?** + +[Please specify exactly how you ran kube-bench, including details of command parameters and/or job file that you used to run it] + +**What happened?** + +[Please include output from the report to illustrate the problem. If possible please supply logs generated with the `-v 3` parameter.] **What did you expect to happen:** +[Please describe what you expected to happen differently.] + **Environment** -[Please specify the version of kube-bench and Kubernetes] +[What is your version of kube-bench? (run `kube-bench version`)] + +[What is your version of Kubernetes? (run `kubectl version` or `oc version` on OpenShift.)] + +**Running processes** + +[Please include the output from running `ps -eaf | grep kube` on the affected node. This will allow us to check what Kubernetes processes are running, and how this compares to what kube-bench detected.] + +**Configuration files** + +[If kube-bench is reporting an issue related to the settings defined in a config file, please attach the file, or include an extract showing the settings that are being detected incorrectly.] **Anything else you would like to add:** -- GitLab