|
| 1 | +## Overview |
| 2 | + |
| 3 | +RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions. |
| 4 | +Pull requests is the primary place of discussing code changes. |
| 5 | + |
| 6 | +## The Process |
| 7 | + |
| 8 | +The process is fairly standard: |
| 9 | + |
| 10 | + * Fork the repository or repositories you plan on contributing to |
| 11 | + * Clone [RabbitMQ umbrella repository](https://github.com/rabbitmq/rabbitmq-public-umbrella) |
| 12 | + * `cd umbrella`, `make co` |
| 13 | + * Create a branch with a descriptive name in the relevant repositories |
| 14 | + * Make your changes, run tests, commit with a [descriptive message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), push to your fork |
| 15 | + * Submit pull requests with an explanation what has been changed and **why** |
| 16 | + * Submit a filled out and signed [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) if needed (see below) |
| 17 | + * Be patient. We will get to your pull request eventually |
| 18 | + |
| 19 | +If what you are going to work on is a substantial change, please first ask the core team |
| 20 | +of their opinion on [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users). |
| 21 | + |
| 22 | + |
| 23 | +## (Brief) Code of Conduct |
| 24 | + |
| 25 | +In one line: don't be a dick. |
| 26 | + |
| 27 | +Be respectful to the maintainers and other contributors. Open source contributors |
| 28 | +put long hours into developing projects and doing user support that are then |
| 29 | +available for free. We believe this deserves some respect. |
| 30 | + |
| 31 | +Be respectful to people of all races, genders, religious beliefs and |
| 32 | +political views. Regardless of how brilliant a pull request is |
| 33 | +technically, we will not tolerate disrespectful or aggressive |
| 34 | +behaviour. |
| 35 | + |
| 36 | +Contributors who violate this straightforward Code of Conduct will see |
| 37 | +their pull requests closed and locked. |
| 38 | + |
| 39 | + |
| 40 | +## Contributor Agreement |
| 41 | + |
| 42 | +If you want to contribute a non-trivial change, please submit a signed copy of our |
| 43 | +[Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) around the time |
| 44 | +you submit your pull request. This will make it much easier (in some cases, possible) |
| 45 | +for the RabbitMQ team at Pivotal to merge your contribution. |
| 46 | + |
| 47 | + |
| 48 | +## Getting Help |
| 49 | + |
| 50 | +If something isn't clear, feel free to ask on our [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users). |
0 commit comments