diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 48 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 8 |
2 files changed, 14 insertions, 42 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 70b54cd818..80777ea0f5 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,43 +1,15 @@ -Thank you for using RabbitMQ and for taking the time to report an -issue. +Thank you for using RabbitMQ. -## Does This Belong to GitHub or RabbitMQ Mailing List? +**STOP NOW AND READ THIS** BEFORE OPENING A NEW ISSUE ON GITHUB -*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. +Unless you are CERTAIN you have found a reproducible problem in RabbitMQ +or have a **specific, actionable** suggestion for our team, you must +first ask your question or discuss your suspected issue on the [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users). Team RabbitMQ does not use GitHub issues +for discussions, investigations, root cause analysis and so on. -## Please Help Maintainers and Contributors Help You +Please take the time to read the `CONTRIBUTING.md` document for instructions on [how +to effectively ask a question or report a suspected issue](https://github.com/rabbitmq/rabbitmq-server/blob/master/CONTRIBUTING.md#github-issues) on the mailing list. -In order for the RabbitMQ team to investigate your issue, please provide -**as much as possible** of the following details: +Following these rules **will save time** to both your and the maintainers. -* 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 +Thank you. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4bd618567b..230febf8a2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,11 +16,11 @@ As long as we can understand the intent, it's all good. 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) +- [ ] Bug fix (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) +- [ ] Breaking change (fix or feature that would cause an observable behavior change in existing systems) +- [ ] Documentation improvements (corrections, new content, etc) +- [ ] Cosmetic change (whitespace, formatting, etc) ## Checklist |