Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 1.36 KB

Contributing

Do you have a question?

GitHub Issues are used for bug reports and new features.

Please ask questions about how to use the library on Stack Overflow.

Did you find a bug?

  • Ensure the bug was not already reported by searching Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample demonstrating the expected behavior that is not occurring.

Did you fix a bug or add a feature?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

How to set up a development environment:

Fork the repo:
git clone git@github.com:rgeo/rgeo.git
Install gem dependencies:
bundle install
Install Geos (optional)

(OSX)

brew install geos

(Ubuntu)

apt-get install libgeos-dev
Make sure the tests pass:
bundle exec rake

If you are working on the C extension, consider setting MAINTAINER_MODE=1 to have extra information when compiling.

Check that your code style is OK
rubocop
bin/clang-format