Contributing to Geokit
I encourage you to submit a patch if you have a bug fix or improvement for Geokit. Please read these guidelines:
- all tests must pass
- if you're making non-trivial changes to the gem, make sure the tests continue to pass for the Rails plugin too.
- if you're just making changes to the plugin, obviously its tests have to pass
- include new tests to cover whatever changes / improvements you've made.
- don't forget changes to the README file explaining any new features you've added.
- if you would like some feedback on changes for which you don't have tests yet, don't send a pull request. Post a link to your github branch in the Google group instead.
Running the Gem Tests
git clone git://github.com/andre/geokit-gem.git
cd geokit-gem
rake test
Note, you will get some warnings like this, don't worry about them:
./lib/geokit/mappable.rb:225: warning: method redefined; discarding old lat=
You may also get some debug output during the test run itself. As long as you get no failures/errors, you're in good shape:
xxx tests, xxx assertions, 0 failures, 0 errors
Like any project, develop in a local branch, and ensure your tests pass with a clean checkout first.
Running the Plugin Tests
you need a database called
geokit_plugin_test. Create that now.$ git clone git://github.com/andre/geokit-rails.git $ cd geokit-rails $ rake test
Thanks for your contributions!
