Skip to content

Commit

Permalink
Add a CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelklishin committed Dec 8, 2017
1 parent 24416ca commit 4e7ea5a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to Ra

## Overview

Ra is a project under heavy development, so consider discussing your idea with
the maintainers on the RabbitMQ mailing list, rabbitmq-users.

The process is fairly standard and straightforward:

* Fork the repository
* Create a branch for your changes
* Add tests, modify code, refactor, repeat
* Push your branch
* Submit a pull request with a reasonably detailed justification of your changes
* Be patient


## Building

Ra uses [erlang.mk](https://erlang.mk/) for build system. Build it with

make

Clean compilation artifacts with

make clean

## Running Tests

make tests

and then open `logs/index.html` to see test run results.

0 comments on commit 4e7ea5a

Please sign in to comment.