2016-09-21 00:19:24 +08:00
## Overview
RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions.
Pull requests is the primary place of discussing code changes.
## How to Contribute
The process is fairly standard:
* Fork the repository or repositories you plan on contributing to
2021-07-02 22:21:54 +08:00
* Run `make`
2016-09-21 00:19:24 +08:00
* Create a branch with a descriptive name in the relevant repositories
2019-03-20 16:22:38 +08:00
* Make your changes, run tests, commit with a [descriptive message ](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ), push to your fork
2016-09-21 00:19:24 +08:00
* Submit pull requests with an explanation what has been changed and **why**
2021-09-23 20:29:36 +08:00
* Submit a filled out and signed [Contributor Agreement ](https://cla.pivotal.io/ ) if needed (see below)
2016-09-21 00:19:24 +08:00
* Be patient. We will get to your pull request eventually
If what you are going to work on is a substantial change, please first ask the core team
of their opinion on [RabbitMQ mailing list ](https://groups.google.com/forum/#!forum/rabbitmq-users ).
2020-11-20 23:41:46 +08:00
## Running Tests
To run all tests in a particular project:
```
cd deps/rabbit
make tests
```
To run a specific suite:
```
cd deps/rabbit
make ct-cluster_rename
```
You can also run specific test groups and tests:
```
cd deps/rabbit
make ct-cluster_rename t=cluster_size_3:partial_one_by_one
```
Test output is in the `logs/` subdirectory.
2016-09-21 00:19:24 +08:00
## Code of Conduct
See [CODE_OF_CONDUCT.md ](./CODE_OF_CONDUCT.md ).
## Contributor Agreement
If you want to contribute a non-trivial change, please submit a signed copy of our
2021-09-23 20:29:36 +08:00
[Contributor Agreement ](https://cla.pivotal.io/ ) around the time
2016-09-21 00:19:24 +08:00
you submit your pull request. This will make it much easier (in some cases, possible)
for the RabbitMQ team at Pivotal to merge your contribution.
## Where to Ask Questions
If something isn't clear, feel free to ask on our [mailing list ](https://groups.google.com/forum/#!forum/rabbitmq-users ).