Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.2 KB
Raw

Contributing

The workflow is pretty standard:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Run integration tests (see below)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push -u origin my-new-feature)
  6. Submit a pull request

Running Tests

Required Plugins

The test suite assumes you have a RabbitMQ node running on localhost with rabbitmq_management and rabbitmq_shovel_management plugins enabled and that rabbitmqctl is available in PATH (or RABBITHOLE_RABBITMQCTL points to it).

To enable the plugins:

rabbitmq-plugins enable rabbitmq_management rabbitmq_shovel_management

That will enable rabbitmq_shovel as a dependency.

Setting Up Virtual Hosts and Permissions

Before running the tests, make sure to run bin/ci/before_build.sh that will create a vhost and user(s) needed by the test suite.

Running Tests

The project uses Ginkgo and Gomega.

To clone dependencies and run tests, use make. It is also possible to use the brilliant Ginkgo CLI runner e.g. to only run a subset of tests.