The wradlib project encourages everyone to contribute to the developement of wradlib. This paper describes the general guidelines for contributing to wradlib. There is more information on wradlib's community effort at the project's main website wradlib.org.
In general wradlib uses GitHub Pull Requests for contribution. Second, the wradlib developers have GitHub Commit Access to the project's main repository.
Contributors to wradlib are expected to act respectfully toward others in accordance with the OSGeo Code of Conduct.
All contributions shall comply to the project license.
Source code, testing, bug tracking as well as docs and wiki are handled via GitHub.
- wradlib's documentation source is contained in wradlib-docs repository, and mainly written in reStructuredText.
- Jupyter Notebooks in wradlib-notebooks repository are utilized to extend the documentation with examples and tutorials.
- wradlib uses Sphinx and nbsphinx to compile docs on readthedocs.org.
Using wradlib's GitHub issue tracker users can file bug reports or discuss feature requests. Bug reports should contain used wradlib as well as Python and OS version, error messages and instructions to reproduce the bug.
For this purpose, you need to have a GitHub Account and Git. Then fork wradlib, make changes and create a pull request. A step-by-step guide can be found in the docs.
To keep the code as clean as much all code contributions should be in line with PEP 8 conventions.