From 686048ca558987240a93e8da36f0ee86871addd7 Mon Sep 17 00:00:00 2001 From: Scott Lee Date: Sun, 4 Aug 2019 15:41:24 -0700 Subject: [PATCH 1/3] Add issue templates --- .github/ISSUE_TEMPLATE/bug.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++++++++++ 4 files changed, 49 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000000..6763f7354c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,13 @@ +--- +name: Bug report +about: Share about things that are not working as expected + +--- + +/kind bug + +**Bug description:** +[Describe the bug in detail including how to reproduce it. Please include any relevant output or screenshots.] + +**System information:** +[Please include your OS, Kubernetes, and kubectl versions as well as anything else that is relevant for us to reproduce or understand the issue.] diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000000..2558d83df4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,13 @@ +--- +name: Documentation +about: Report any mistakes or missing information from the documentation or the examples + +--- + +/kind documentation + +**Link to the issue:** +[Please include a link to the specific documentation or example.] + +**Description of the issue:** +[Describe the issue in detail including screenshots and text pastes. Pleae also include what the fix should be if possible.] diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000000..7e2e98580b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,13 @@ +--- +name: Feature request +about: Suggest a functionality not supported by the project + +--- + +/kind feature + +**What is the feature and why do you need it:** +[Is your feature request related to a problem? Please describe the problem in detail including any workarounds you are using.] + +**Describe the solution you'd like:** +[A clear and concise description of what you want to happen.] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..e957e5b48b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: Ask any questions about the project + +--- + +/triage support + +**Question:** +[Ask any question about this project but please include relevant details such as versions, screenshots, or error output as well as what you've tried already.] From e74cd71b44357e32ffa4a692a9003c9531c065af Mon Sep 17 00:00:00 2001 From: Scott Lee Date: Wed, 7 Aug 2019 22:38:57 -0700 Subject: [PATCH 2/3] Include feedback fixes --- .github/ISSUE_TEMPLATE/bug.md | 17 ++++++++++++----- .github/ISSUE_TEMPLATE/documentation.md | 9 +++------ .github/ISSUE_TEMPLATE/feature.md | 9 +++------ .github/ISSUE_TEMPLATE/question.md | 10 ---------- 4 files changed, 18 insertions(+), 27 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 6763f7354c..ad1b1203dd 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,13 +1,20 @@ --- name: Bug report about: Share about things that are not working as expected +labels: kind/bug --- -/kind bug +**What happened (please include outputs or screenshots)**: -**Bug description:** -[Describe the bug in detail including how to reproduce it. Please include any relevant output or screenshots.] +**What you expected to happen**: -**System information:** -[Please include your OS, Kubernetes, and kubectl versions as well as anything else that is relevant for us to reproduce or understand the issue.] +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment**: +- Kubernetes version (`kubectl version`): +- OS (e.g., MacOS 10.13.6): +- Python version (`python --version`) +- Python client version (`pip list | grep kubernetes`) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 2558d83df4..75bef6b7d7 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -1,13 +1,10 @@ --- name: Documentation about: Report any mistakes or missing information from the documentation or the examples +labels: kind/documentation --- -/kind documentation +**Link to the issue (please include a link to the specific documentation or example)**: -**Link to the issue:** -[Please include a link to the specific documentation or example.] - -**Description of the issue:** -[Describe the issue in detail including screenshots and text pastes. Pleae also include what the fix should be if possible.] +**Description of the issue (please include outputs or screenshots if possible)**: diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index 7e2e98580b..d5c4987915 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,13 +1,10 @@ --- name: Feature request about: Suggest a functionality not supported by the project +labels: kind/feature --- -/kind feature +**What is the feature and why do you need it**: -**What is the feature and why do you need it:** -[Is your feature request related to a problem? Please describe the problem in detail including any workarounds you are using.] - -**Describe the solution you'd like:** -[A clear and concise description of what you want to happen.] +**Describe the solution you'd like to see**: diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index e957e5b48b..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Question -about: Ask any questions about the project - ---- - -/triage support - -**Question:** -[Ask any question about this project but please include relevant details such as versions, screenshots, or error output as well as what you've tried already.] From f4a47ed041d25b5101e5971131b6636f1c43d632 Mon Sep 17 00:00:00 2001 From: Scott Lee Date: Fri, 9 Aug 2019 13:55:42 -0700 Subject: [PATCH 3/3] Fix wording --- .github/ISSUE_TEMPLATE/feature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index d5c4987915..466b4f87ba 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Suggest a functionality not supported by the project +about: Suggest a new feature for the project labels: kind/feature ---