Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 1.5 KB
Raw

Contributing

Thanks for using and improving HTML::Pipeline!

Submitting a New Issue

If there's an idea you'd like to propose, or a design change, feel free to file a new issue.

If you have an implementation question or believe you've found a bug, please provide as many details as possible:

  • Input document
  • Output HTML document
  • the exact HTML::Pipeline code you are using
  • output of the following from your project
ruby -v
bundle exec nokogiri -v

Sending a Pull Request

Pull requests are always welcome!

Check out the project's issues list for ideas on what could be improved.

Before sending, please add tests and ensure the test suite passes.

Running the Tests

To run the full suite:

bundle exec rake

To run a specific test file:

bundle exec ruby -Itest test/html/pipeline_test.rb

To run a specific test:

bundle exec ruby -Itest test/html/pipeline/markdown_filter_test.rb -n test_disabling_gfm

To run the full suite with all supported rubies in bash:

rubies=(ree-1.8.7-2011.03 1.9.2-p290 1.9.3-p429 2.0.0-p247)
for r in ${rubies[*]} 
do 
  rbenv local $r # switch to your version manager of choice
  bundle install 
  bundle exec rake 
done