Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

33 lines (29 loc) · 1.37 KB
Raw

Submitting a Pull Request

  1. Fork the repository.

  2. Create a topic branch.

  3. Check which version of Ruby is installed on your machine with ruby -v. The list of supported Ruby versions is listed in .travis.yml. Set up one of these versions; use of RVM is recommended to switch easily between different versions.

  4. Install bundler.

  5. Make sure to have the tidy command on your system:

    • apt-get install tidy
    • yum install tidy
    • pacman -S tidyhtml

  6. Check that unit tests pass with rake test.

  7. Write a failing test to capture existing bug or lack of feature.

  8. Run rake test to verify that test fails.

  9. Implement your feature or bug fix.

  10. Ensure tests pass.

  11. If it's a new feature or a bug fix, please add an entry to the changelog file.

  12. Add, commit, and push your changes.

  13. Submit a pull request.

  14. You will get some feedback and may need to push additional commits with more fixes to the same branch; this will update your pull request automatically.