Update PR & issue template (addressed comments, more interactive, sho…

…rter)
kubernetes · Aug 12, 2016 · de91512 · de91512
1 parent 189e97f
commit de91512
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 43 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,18 +1,15 @@
-<!-- PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING
+<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->
 
-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):
+
+<!--
 If this is a BUG REPORT, please:
   - Fill in as much of the template below as you can.  If you leave out
     information, we can't help you as well.
@@ -26,27 +23,25 @@ might close your issue.  If we're wrong, PLEASE feel free to reopen it and
 explain why.
 -->
 
-----------
-BUG REPORT
-----------
-
-*Kubernetes version*: (try `kubctl version`)
-
-
-*Environment (e.g. cloud provider, OS, kernel, install tools)*:
+**Kubernetes version** (use `kubectl version`):
 
 
-*What happened*:
+**Environment**:
+- **Cloud provider or hardware configuration**:
+- **OS** (e.g. from /etc/os-release):
+- **Kernel** (e.g. `uname -a`):
+- **Install tools**:
+- **Others**:
 
 
-*What you expected to happen*:
+**What happened**:
 
 
-*How to reproduce it, as minimally and precisely as possible*:
+**What you expected to happen**:
 
 
-*Anything else do we need to know*:
+**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
@@ -1,25 +1,19 @@
-<!-- PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING
+<!--  Thanks for sending a pull request!  Here are some tips for you:
+1. If this is your first time, read our contributor guidelines https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.md and developer guide https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md
+2. If you want *faster* PR reviews, read how: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/faster_reviews.md
+3. Follow the instructions for writing a release note: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/pull-requests.md#release-notes
+-->
 
-Thanks for sending a pull request!  Before hitting the button, please read
-this.
+**What this PR does / why we need it**:
 
-1. Please make sure this comment describes:
-  - What you did
-  - Why you did it
-  - Things to consider when reviewing
-2. Read our contributor guidelines: https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.md
-3. See our developer guide: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md
-4. If you want this PR to automatically close an issue when it is merged,
-   add `fixes #<issue number>` or `fixes #<issue number>, fixes #<issue number>`
-   to close multiple issues (see: https://github.com/blog/1506-closing-issues-via-pull-requests).
-5. Follow the instructions for writing a release note: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/pull-requests.md#release-notes
--->
+**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #
 
+**Special notes for your reviewer**:
 
+**Release note**:
+<!--  Steps to write your release note:
+1. Use the release-note-* labels to set the release note state (if you have access) 
+2. Enter your extended release note in the below block; leaving it blank means using the PR title as the release note. If no release note is required, just write `NONE`. 
+-->
 ```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
 ```