CONTRIBUTING.md

How to contribute

Bug reports and pull requests from users are what keep this project working.

Basics

1. Create an issue and describe your idea
2. Fork it
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Publish the branch (git push origin my-new-feature)
6. Create a new Pull Request

Checking your work

You can run the test suite.

You can run RuboCop to check code style.

You can run RSpec to see if anything broke.

You can run YARD to see of your code is documented.

The default Rake task, runnable using rake.

Write documentation

This project has documentation in a few places:

Introduction and usage

A friendly README.md written for many audiences.

Examples and advanced usage

The wiki.

API documentation

API documentation is written as YARD docblocks in the Ruby code.

This is rendered as Web pages on Rubydoc.info.