Contributing

We value any contribution to Marlowe you can provide: a bug report, a feature request, or code contributions. Marlowe is reasonably complex code, so there are a few contribution guidelines:

Test Dependencies

Marlowe uses Ryan Davis’s Hoe to manage the release process, which adds a number of rake tasks. You will mostly be interested in:

$ rake

which runs the tests the same way that:

$ rake test
$ rake travis

will do.

To assist with the installation of the development dependencies for Marlowe, I have provided the simplest possible Gemfile pointing to the (generated) marlowe.gemspec file. This will permit you to do:

$ bundle install

to get the development dependencies. If you aleady have hoe installed, you can accomplish the same thing with:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the RDoc.

Workflow

Here's the most direct way to get your work merged into the project:

Contributors