I'm so glad you're reading this, because we need volunteer developers to help this project grow and thrive!
Before you begin, ensure that your contribution is associated with a GitHub issue. If there isn't an existing issue, please create one.
- Fork the repository
- Create a new branch (
git checkout -b feature-branch) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin feature-branch) - Create a new Pull Request
Please make sure that your code passes the existing tests and add tests for any new functionality. Please write RSpec examples for new features you add or modify.
To execute the tests, run bundle exec rake spec.
This project uses Rubocop to enforce a consistent coding style. Please make sure that your code passes the Rubocop checks.
To execute Rubocop, run bundle exec rake rubocop.
Please make sure that your code is well documented. If you add new features, please add documentation for them. This project uses YARD for documentation, so please add YARD tags to your code when appropriate.
By contributing your code, you agree to license your contribution under the terms of the MIT License.
By participating in this project, you agree to abide by our Code of Conduct.
Please use the GitHub issue tracker to report any bugs.
If you have ideas for enhancements or improvements please use the GitHub issue tracker to suggest them.
Thank you for your interest in contributing!