Thank you for considering contributing to rwslib.
- Clone the repository
git clone https://github.com/mdsol/rwslib - Install poetry and start a shell
$ pip install poetry $ poetry shell
- Install the development dependencies
$ poetry install --with dev
- Enjoy !!!
The best way to contribute to rwslib is to fork the develop branch of the rwslib repo in github and then raise a pull request back to the develop branch. Our workflow is:
- Branch from and merge to develop
- When ready for new pypi release change the version number and merge develop -> master
We do this because docs are auto-created from a merge to master but also because it allows us to control the rwslib version in pypi, the python packaging index.
We use unittest for tests in rwslib, aiming for a high degree of coverage. Any code contributions should have associated tests.
We test python version compatibility with tox against py27, py34, py35
We document with Sphinx. Updates/additions to documentation are welcome. Please consider adding docs for any new request types you wish to add to the core of the library.
Merges to master have a hook that publishes updated docs to readthedocs. See http://rwslib.readthedocs.org/en/latest/
Contributions to rwslib are recognized in the AUTHORS.rst file. We welcome contributions large and small!