1.9 KiB
1.9 KiB
Contributing
In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute:
- Use alpha, beta, and pre-release versions.
- Report bugs.
- Suggest new features.
- Write or edit documentation.
- Write specifications.
- Write code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace).
- Refactor code.
- Fix issues.
- Review patches.
- Financially pledge using gittip.
Submitting an Issue
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
- Fork the repository.
- Create a topic branch.
- Add specs for your unimplemented feature or bug fix.
- Run
bundle exec rake spec. If your specs pass, return to step 3. - Implement your feature or bug fix.
- Run
bundle exec rake. If your specs fail, return to step 5. - Run
open coverage/index.html. If your changes are not completely covered by your tests, return to step 3. - Add documentation for your feature or bug fix.
- Run
bundle exec rake verify_measurements. If your changes are not 100% documented, go back to step 8. - Commit and push your changes.
- Submit a pull request.