CONTRIBUTING.md in bunny-2.7.1 vs CONTRIBUTING.md in bunny-2.7.2

- old
+ new

@@ -1,11 +1,32 @@ +## Overview + +This project **does not** use GitHub issues for questions, investigations, discussions, and so on. +Issues are appropriate for something specific enough for a maintainer or contributor to work on: + + * There should be enough information to reproduce the behavior observed in a reasonable amount of time + * It should be reasonably clear why the behavior should be changed and why this cannot or should not be addressed + in application code, a separate library and so on + + All issues that do not satisfy the above properties belong to the [Ruby RabbitMQ clients mailing list](http://groups.google.com/forum/#!forum/ruby-amqp). Pull request that do not satisfy them have a high chance + of being closed. + +## Submitting a Pull Request + +Please read the sections below to get an idea about how to run Bunny test suites first. Successfully +running all tests, at least with `CI` environment variable exported to `true`, is an important +first step for any contributor. + +Once you have a passing test suite, create a branch and make your changes on it. +When you are done with your changes and all +tests pass, write a [good, detailed commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) submit a pull request on GitHub. + ## Pre-requisites The project uses Bundler for dependency management and requires RabbitMQ `3.5+` to be running locally with the `rabbitmq-management` and `rabbitmq_consistent_hash_exchange` plugins enabled. - ### Running the Specs The specs require RabbitMQ to be running locally with a specific set of vhosts and users. RabbitMQ can be provisioned and started any way that's convenient to you as long as it has a suitable TLS keys configuration and management plugin enabled. @@ -86,10 +107,5 @@ bundle exec rspec -c It is possible to run only integration and regression tests but exclude unit and stress tests: CI=true bundle exec rspec -c spec/higher_level_api/ spec/lower_level_api spec/issues && bundle exec rspec -c spec/higher_level_api/integration/connection_recovery_spec.rb - -## Pull Requests - -Then create a branch and make your changes on it. Once you are done with your changes and all -tests pass, write a [good, detailed commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) submit a pull request on GitHub.