From 189e97f0fca757ae8fd782f73af9d7ad5cd53e36 Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Tue, 5 Jul 2016 01:07:01 -0700 Subject: [PATCH 1/2] Add an issue template, tighten PR template I looked at a few other examples of templates and tried to make ours more succint and helpful. Feedback is welcome. --- .github/ISSUE_TEMPLATE.md | 52 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 26 ++++++++++------ 2 files changed, 68 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..0a924c27a5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,52 @@ + + +---------- +BUG REPORT +---------- + +*Kubernetes version*: (try `kubctl version`) + + +*Environment (e.g. cloud provider, OS, kernel, install tools)*: + + +*What happened*: + + +*What you expected to happen*: + + +*How to reproduce it, as minimally and precisely as possible*: + + +*Anything else do we need to know*: + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/.github/ISSUE_TEMPLATE.md?pixel)]() diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f6d242bd38d..6d864984d32 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,25 @@ - + ```release-note -* Use the release-note-* labels to set the release note state -* Clear this block to use the PR title as the release note +* Enter your extended release note here (newlines are formatted as bullets). If this PR does not warrant a release + note, just say `NONE`. -OR- -* Enter your extended release note here (newlines are formatted as bullets) +* Use the release-note-* labels to set the release note state (if you have access) +* Clear this block to use the PR title as the release note ``` From de91512f3049a55b2a125a0fbf47840a2e5290f8 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Fri, 5 Aug 2016 15:27:03 -0700 Subject: [PATCH 2/2] Update PR & issue template (addressed comments, more interactive, shorter) --- .github/ISSUE_TEMPLATE.md | 43 ++++++++++++++------------------ .github/PULL_REQUEST_TEMPLATE.md | 34 +++++++++++-------------- 2 files changed, 33 insertions(+), 44 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 0a924c27a5e..84948635654 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,18 +1,15 @@ - -Thanks for filing an issue! Before hitting the button, please read this. +**Is this a request for help?** (If yes, you should use our troubleshooting guide and community support channels, see http://kubernetes.io/docs/troubleshooting/.): -If this is a REQUEST FOR HELP, it is probably be better served by: - - Stack Overflow: http://stackoverflow.com/questions/tagged/kubernetes - - Mailing list: https://groups.google.com/forum/#!forum/google-containers - - Slack: http://slack.kubernetes.io/ -Please check for duplicates. We know searching for dups can be tricky, but we -appreciate that you try. - - If you find an issue that sounds like your bug/feature, reply there. - - If you just want to say "me too", PLEASE DO NOT REPLY. Instead, use the - smiley-face icon in the upper-right of the issue message. +**What keywords did you search in Kubernetes issues before filing this one?** (If you found any duplicates, you should instead reply there or use the :+1: icon in the upper-right of the issue message): +--- + +**Is this a BUG REPORT or FEATURE REQUEST?** (choose one): + + ----------- -BUG REPORT ----------- - -*Kubernetes version*: (try `kubctl version`) +**Kubernetes version** (use `kubectl version`): -*Environment (e.g. cloud provider, OS, kernel, install tools)*: +**Environment**: +- **Cloud provider or hardware configuration**: +- **OS** (e.g. from /etc/os-release): +- **Kernel** (e.g. `uname -a`): +- **Install tools**: +- **Others**: -*What happened*: +**What happened**: -*What you expected to happen*: +**What you expected to happen**: -*How to reproduce it, as minimally and precisely as possible*: +**How to reproduce it** (as minimally and precisely as possible): -*Anything else do we need to know*: +**Anything else do we need to know**: - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/.github/ISSUE_TEMPLATE.md?pixel)]() diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6d864984d32..2c9745963f3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,19 @@ - +**What this PR does / why we need it**: +**Which issue this PR fixes** *(optional, in `fixes #(, #, ...)` format, will close that issue when PR gets merged)*: fixes # + +**Special notes for your reviewer**: + +**Release note**: + ```release-note -* Enter your extended release note here (newlines are formatted as bullets). If this PR does not warrant a release - note, just say `NONE`. --OR- -* Use the release-note-* labels to set the release note state (if you have access) -* Clear this block to use the PR title as the release note ```