The PyWPS project openly welcomes contributions (bug reports, bug fixes, code enhancements/features, etc.). This document will outline some guidelines on contributing to PyWPS. As well, the PyWPS community is a great place to get an idea of how to connect and participate in the PyWPS community and development.
PyWPS has the following modes of contribution:
- GitHub Commit Access
- GitHub Pull Requests
Contributors to this project are expected to act respectfully towards others in accordance with the OSGeo Code of Conduct.
Contributors are asked to confirm that they comply with the project license guidelines.
- proposals to provide developers with GitHub commit access shall be emailed to the pywps-devel mailing list. Proposals shall be approved by the PyWPS development team. Committers shall be added by the project admin
- removal of commit access shall be handled in the same manner
- each committer must send an email to the PyWPS mailing list agreeing to the license guidelines (see Contributions and Licensing Agreement Template). This is only required once
- each committer shall be listed in https://github.com/geopython/pywps/blob/main/COMMITTERS.txt
pull requests can provide agreement to license guidelines as text in the pull request or via email to the PyWPS mailing list (see Contributions and Licensing Agreement Template). This is only required for a contributor's first pull request. Subsequent pull requests do not require this step
pull requests may include copyright in the source code header by the contributor if the contribution is significant or the contributor wants to claim copyright on their contribution
all contributors shall be listed at https://github.com/geopython/pywps/graphs/contributors
unclaimed copyright, by default, is assigned to the main copyright holders as specified in https://github.com/geopython/pywps/blob/main/LICENSE.txt
make sure, the tests are passing on [GitHub CI](https://github.com/geopython/pywps/actions/workflows/main.yml) service, as well as on your local machine tox:
$ tox
Hi all, I'd like to contribute <feature X|bugfix Y|docs|something else> to
PyWPS. I confirm that my contributions to PyWPS will be compatible with the
PyWPS license guidelines at the time of contribution.
Code, tests, documentation, wiki and issue tracking are all managed on GitHub. Make sure you have a GitHub account.
- the PyWPS wiki documents an overview of the codebase [TODO]
- documentation is managed in
docs/, in reStructuredText format - Sphinx is used to generate the documentation
- See the reStructuredText Primer on reST markup and syntax
The PyWPS issue tracker is the place to report bugs or request enhancements. To submit a bug be sure to specify the PyWPS version you are using, the appropriate component, a description of how to reproduce the bug, as well as the Python version and the platform.
Contributions are most easily managed via GitHub pull requests. Fork PyWPS into your own GitHub repository to be able to commit your work and submit pull requests.
- enhancements and bug fixes should be identified with a GitHub issue
- commits should be granular enough for other developers to understand the nature / implications of the change(s)
- for trivial commits that do not need GitHub CI to run, include
[ci skip]as part of the commit message - non-trivial Git commits shall be associated with a GitHub issue. As documentation can always be improved, tickets need not be opened for improving the docs
- Git commits shall include a description of changes
- Git commits shall include the GitHub issue number (i.e.
#1234) in the Git commit log message - all enhancements or bug fixes must successfully pass all OGC CITE tests before they are committed
- all enhancements or bug fixes must successfully pass all tests before they are committed
- enhancements which can be demonstrated from the PyWPS tests should be accompanied by example WPS request XML or KVP
- PyWPS instead of pywps, pyWPS, Pywps, PYWPS
- always code with PEP8 conventions
- always run source code through
flake8 - for exceptions which make their way to OGC
ows:ExceptionReportXML, always specify the appropriatelocatorandcodeparameters
This section will guide you through steps of working on PyWPS. This section
assumes you have forked PyWPS into your own GitHub repository. Note that
main is the main development branch in PyWPS.
for stable releases and managed exclusively by the PyWPS team.
# setup a virtualenv
$ virtualenv mypywps && cd mypywps
$ . ./bin/activate
# clone the repository locally
$ git clone [email protected]:USERNAME/pywps.git
$ cd pywps
$ pip install -e . && pip install -r requirements.txt
# add the main PyWPS development branch to keep up to date with upstream changes
$ git remote add upstream https://github.com/geopython/pywps.git
$ git pull upstream main
# create a local branch off main
# The name of the branch should include the issue number if it exists
$ git branch issue-72
$ git checkout issue-72
# make code/doc changes
$ git commit -am 'fix xyz (#72)'
$ git push origin issue-72Your changes are now visible on your PyWPS repository on GitHub. You are now ready to create a pull request. A member of the PyWPS team will review the pull request and provide feedback / suggestions if required. If changes are required, make them against the same branch and push as per above (all changes to the branch in the pull request apply).
The pull request will then be merged by the PyWPS team. You can then delete your local branch (on GitHub), and then update your own repository to ensure your PyWPS repository is up to date with PyWPS main:
$ git checkout main
$ git pull upstream mainRelease packaging notes are maintained at https://github.com/geopython/pywps/wiki/ReleasePackaging