broilerplate Build Status Code Climate Coverage Status

If this isn't the repository "broilerplate", chances are the authors of this repository didn't add a proper README yet and left the boilerplate (me) here.

My personal broilerplate for Ruby libraries. Fork and code ahead.


Fork and clone, then execute:

$ bundle

To verify that everything works, run the CI task, and the included example.

$ bundle exec rake ci
$ bundle exec ruby examples/getting_started.rb

Now replace all occurences of [Bb]roilerplate with your library's name. Also replace the metadata in the gemspec.

You also want to enable the Travis and Rdocinfo hooks for your GitHub repository.


broilerplate is free and unencumbered public domain software. For more information, see or the accompanying UNLICENSE file.


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request