We value all kinds of contributions from the community, not just actual code. Perhaps the easiest and yet one of the most valuable ways of helping us improve GeoPySpark is to ask questions, voice concerns or propose improvements on the GeoTrellis Mailing List. As of now, we will be using this to interact with our users. However, this could change depending on the volume/interest of users.
If you do like to contribute actual code in the form of bug fixes, new features or other patches this page gives you more info on how to do it.
Ensure you have the `project dependencies<https://github.com/locationtech-labs/geopyspark/blob/master/README.rst#requirements>`_ installed on your machine.
Then follow the `Installing for Developers<https://github.com/locationtech-labs/geopyspark/blob/master/README.rst#installing-for-developers>`_ instructions in the project README.
We try to follow the PEP 8 Style Guide for Python Code as closely as possible, although you will see some variations throughout the codebase. When in doubt, follow that guide.
Git Branching Model¶
The GeoPySpark team follows the standard practice of using the
master branch as main integration branch.
Git Commit Messages¶
We follow the ‘imperative present tense’ style for commit messages. (e.g. “Add new EnterpriseWidgetLoader instance”)
If you find a bug and would like to report it please go there and create an issue. As always, if you need some help join us on Gitter to chat with a developer. As with the mailing list, we will be using the GeoTrellis Gitter channel until the need arises to form our own.
If you’d like to submit a code contribution please fork GeoPySpark and
send us pull request against the
master branch. Like any other open
source project, we might ask you to go through some iterations of
discussion and refinement before merging.
As part of the Eclipse IP Due Diligence process, you’ll need to do some
extra work to contribute. This is part of the requirement for Eclipse
Foundation projects (see this page in the Eclipse
You’ll need to sign up for an Eclipse account with the same email you
commit to github with. See the
Eclipse Contributor Agreement text
below. Also, you’ll need to signoff on your commits, using the
git commit -s flag. See
https://help.github.com/articles/signing-tags-using-gpg/ for more info.
Eclipse Contributor Agreement (ECA)¶
Contributions to the project, no matter what kind, are always very welcome. Everyone who contributes code to GeoTrellis will be asked to sign the Eclipse Contributor Agreement. You can electronically sign the Eclipse Contributor Agreement here.
Editing these Docs¶
Contributions to these docs are welcome as well. To build them on your own
machine, ensure that
make are installed.
> sudo apt-get install python-sphinx python-sphinx-rtd-theme
> sudo pacman -S python-sphinx python-sphinx_rtd_theme
brew doesn’t supply the sphinx binaries, so use
> pip install sphinx sphinx_rtd_theme
Building the Docs¶
Assuming you’ve cloned the GeoTrellis repo, you can now build the docs yourself. Steps:
- Navigate to the
- View the docs in your browser by opening
Changes you make will not be automatically applied; you will have to rebuild the docs yourself. Luckily the docs build in about a second.
There is currently not a file structure in place for docs. Though, this will change soon.