Skip to content

Commit

Permalink
Add an issue template, tighten PR template
Browse files Browse the repository at this point in the history
I looked at a few other examples of templates and tried to make ours more
succint and helpful.  Feedback is welcome.
  • Loading branch information
thockin authored and janetkuo committed Aug 12, 2016
1 parent ea69570 commit 189e97f
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 10 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!-- PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING
Thanks for filing an issue! Before hitting the button, please read this.
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.
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.
If this is a FEATURE REQUEST, please:
- Describe *in detail* the feature/behavior/change you'd like to see.
In both cases, be ready for followup questions, and please respond in a timely
manner. If we can't reproduce a bug or think a feature already exists, we
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)*:


*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)]()
26 changes: 16 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
<!--
Checklist for submitting a Pull Request
<!-- PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING
Please remove this comment block before submitting.
Thanks for sending a pull request! Before hitting the button, please read
this.
1. Please read our [contributor guidelines](https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.md).
2. See our [developer guide](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md).
3. If you want this PR to automatically close an issue when it is merged,
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).
4. Follow the instructions for [labeling and writing a release note for this PR](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/pull-requests.md#release-notes) in the block below.
5. Follow the instructions for writing a release note: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/pull-requests.md#release-notes
-->


```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
```

0 comments on commit 189e97f

Please sign in to comment.