Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 1.82 KB

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
  • Run make
  • Create a branch with a descriptive name in the relevant repositories
  • Make your changes, run tests, commit with a descriptive message, push to your fork
  • Submit pull requests with an explanation what has been changed and why
  • Submit a filled out and signed Contributor Agreement if needed (see below)
  • 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.

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.

Code of Conduct

See CODE_OF_CONDUCT.md.

Contributor Agreement

If you want to contribute a non-trivial change, please submit a signed copy of our Contributor Agreement around the time 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.