From 810068acb92f0ecf21e5fa6cf1ae821fd125ba16 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Fri, 6 Dec 2019 15:47:27 -0500 Subject: [PATCH] Add issue templates **What kind of PR is this?** Enhancement to GitHub issue templates **What does does this PR do / why we need it**: In order to streamline / enhance GitHub bug submission and to direct users, we must create issue templates to appropriately submit issues. This PR: - Adds descriptions with regards where to ask for support (StackOverflow, Slack, documentation) before submitting asking developers - Adds improvement to the bug report process **Which issue(s) this PR fixes**: N/A **How to test changes / Special notes to the reviewer**: Yes. Before merging, it's suggested to create the `enhancement` label in order to appropriately label all incoming enhancement issues. Signed-off-by: Charlie Drage --- .github/ISSUE_TEMPLATE/bug-report.md | 23 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 11 +++++++++++ .github/ISSUE_TEMPLATE/support.md | 20 ++++++++++++++++++++ 4 files changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/support.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..6c8506fa9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,23 @@ +--- +name: Bug Report +about: Report a bug encountered while using Helm +labels: bug + +--- + + + +**What happened**: + +**What you expected to happen**: + +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment**: +- Helm version (use `helm version`): +- kubectl version (use `kubectl version`): +- OS (e.g: `cat /etc/os-release`): +- Cloud Provider / Platform (AKS, GKE, Minikube, etc.): +- Others: diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..48dfeea98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,10 @@ +--- +name: Documentation +about: Report mistakes or request for documentation +labels: docs + +--- + +## What mistake did you find / what is missing in the documentation? + +## What is the relevance of it? diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 000000000..1e0e04a61 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,11 @@ +--- +name: Request +about: Suggest an enhancement to Helm +labels: enhancement + +--- + + +**What would you like to be added**: + +**Why is this needed**: diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md new file mode 100644 index 000000000..320dcef49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.md @@ -0,0 +1,20 @@ +--- +name: Support Request +about: Support request or question relating to Helm +labels: question/support + +--- + +