Skip to content

Latest commit

 

History

History
73 lines (56 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

73 lines (56 loc) · 2.93 KB
Raw

Guidelines

Contributions to GeoPandas are very welcome. They are likely to be accepted more quickly if they follow these guidelines.

At this stage of GeoPandas development, the priorities are to define a simple, usable, and stable API and to have clean, maintainable, readable code. Performance matters, but not at the expense of those goals.

In general, GeoPandas follows the conventions of the pandas project where applicable. Please read the pandas contributing guidelines.

In particular, when submitting a pull request:

  • All existing tests should pass. Please make sure that the test suite passes, both locally and on Travis CI. Status on Travis will be visible on a pull request. If you want to enable Travis CI on your own fork, please read the pandas guidelines link above or the getting started docs.

  • New functionality should include tests. Please write reasonable tests for your code and make sure that they pass on your pull request.

  • Classes, methods, functions, etc. should have docstrings. The first line of a docstring should be a standalone summary. Parameters and return values should be documented explicitly.

Improving the documentation and testing for code already in GeoPandas is a great way to get started if you'd like to make a contribution.

Style

  • GeoPandas supports Python 2 (2.7+) and Python 3 (3.5+) with a single code base. Use modern Python idioms when possible that are compatible with both major versions, and use the six library where helpful to smooth over the differences. Use from __future__ import statements where appropriate. Test code locally in both Python 2 and Python 3 when possible (all supported versions will be automatically tested on Travis CI).

  • GeoPandas follows the PEP 8 standard and uses Black and Flake8 to ensure a consistent code format throughout the project.

  • Imports should be grouped with standard library imports first, 3rd-party libraries next, and GeoPandas imports third. Within each grouping, imports should be alphabetized. Always use absolute imports when possible, and explicit relative imports for local imports when necessary in tests.

  • You can set up pre-commit hooks to automatically run black and flake8 when you make a git commit. This can be done by installing pre-commit:

    $ python -m pip install pre-commit

    From the root of the geopandas repository, you should then install pre-commit:

    $ pre-commit install

    Then black and flake8 will be run automatically each time you commit changes. You can skip these checks with git commit --no-verify.