Add GitHub issue and pull request templates, update CONTRIBUTING.md

2 files changed, 86 insertions, 0 deletions

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000000..70b54cd818
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,43 @@
+Thank you for using RabbitMQ and for taking the time to report an
+issue.
+
+## Does This Belong to GitHub or RabbitMQ Mailing List?
+
+*Important:* please first read the `CONTRIBUTING.md` document in the
+root of this repository. It will help you determine whether your
+feedback should be directed to the RabbitMQ mailing list [1] instead.
+
+## Please Help Maintainers and Contributors Help You
+
+In order for the RabbitMQ team to investigate your issue, please provide
+**as much as possible** of the following details:
+
+* RabbitMQ version
+* Erlang version
+* RabbitMQ server and client application log files
+* A runnable code sample, terminal transcript or detailed set of
+  instructions that can be used to reproduce the issue
+* RabbitMQ plugin information via `rabbitmq-plugins list`
+* Client library version (for all libraries used)
+* Operating system, version, and patch level
+
+Running the `rabbitmq-collect-env` [2] script can provide most of the
+information needed. Please make the archive available via a third-party
+service and note that **the script does not attempt to scrub any
+sensitive data**.
+
+If your issue involves RabbitMQ management UI or HTTP API, please also provide
+the following:
+
+ * Browser and its version
+ * What management UI page was used (if applicable)
+ * How the HTTP API requests performed can be reproduced with `curl`
+ * Operating system on which you are running your browser, and its version
+ * Errors reported in the JavaScript console (if any)
+
+This information **greatly speeds up issue investigation** (or makes it
+possible to investigate it at all).  Please help project maintainers and
+contributors to help you by providing it!
+
+1. https://groups.google.com/forum/#!forum/rabbitmq-users
+2. https://github.com/rabbitmq/support-tools/blob/master/scripts/rabbitmq-collect-env
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..4bd618567b
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,43 @@
+## Proposed Changes
+
+Please describe the big picture of your changes here to communicate to the
+RabbitMQ team why we should accept this pull request. If it fixes a bug or
+resolves a feature request, be sure to link to that issue.
+
+A pull request that doesn't explain **why** the change was made has a much
+lower chance of being accepted.
+
+If English isn't your first language, don't worry about it and try to
+communicate the problem you are trying to solve to the best of your abilities.
+As long as we can understand the intent, it's all good.
+
+## Types of Changes
+
+What types of changes does your code introduce to this project?
+_Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (non-breaking change which fixes issue #NNNN)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation (correction or otherwise)
+- [ ] Cosmetics (whitespace, appearance)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating
+the PR. If you're unsure about any of them, don't hesitate to ask on the
+mailing list. We're here to help! This is simply a reminder of what we are
+going to look for before merging your code._
+
+- [ ] I have read the `CONTRIBUTING.md` document
+- [ ] I have signed the CA (see https://cla.pivotal.io/sign/rabbitmq)
+- [ ] All tests pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in related repositories
+
+## Further Comments
+
+If this is a relatively large or complex change, kick off the discussion by
+explaining why you chose the solution you did and what alternatives you
+considered, etc.