Skip to content

How To: Contributing to Kaminari

plribeiro3000 edited this page Jun 9, 2012 · 2 revisions

☇ Before Starting Contributing

Before you start contributing to Kaminari, you should check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.You should also check out the issue tracker to make sure someone already hasn't requested it and/or contributed it. There might be fixes/features on these places.

☇ Steps to send a pull request

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

    To run all tests at once, simply run:

    bundle exec rake spec:all
    

    If you want to run each set of tests for each ORM library, just use the corresponding tasks:

    bundle exec rake spec:active_record_30
    

    To see the complete list of supported ORMs:

    bundle exec rake -T
    
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.