We are always looking for contributions! You can find below some relevant information and
standards for rootsstyle.
After cloning the repo, make sure to set up the environment.
We use Poetry for both managing environments and packaging. That means you need to install poetry but from there you can use the tool to create the environment.
pip install poetry==1.1.12
poetry install # installs prod and dev dependenciesRemember that to use the environment you can use the poetry run <COMMAND> command or
initialize the shell with poetry shell. For example, if you want to create the
coverage report you could run
poetry run pytest --cov=rootsstyle tests/or alternatively
poetry shell
pytest --cov=rootsstyle tests/We welcome new features, bugfixes or enhancements (whether on code or docs). There are a few standards we adhere to, that are required for new features.
We use type hints! There are a couple of reasons for using type hints, mainly:
- Better code coverage (avoid errors during runtime)
- Improve code understanding
In regards to code quality, we use a couple of linting tools to maintain the same "style" and uphold to the same standards. For that, we use:
As for documentation, the rootsstyle documentation "lives" both on the code itself and
supporting documentation (markdown) files.
Code docs include annotating type hints as well as function docstrings.
We use unit tests to ensure that our package works as expected. We use
pytest for testing and
Pytest-cov for checking how much of
the code is covered in our tests.
The tests should mimic the package directory structure. The tests are also written to serve as an example of how to use the classes and methods and expected outputs.
Publishing is automatically done via Github Actions to PiPy. After published, a new tag and release are created. The Changelog is also automatically updated based on your commits.
rootsstyle was created by Yannou Ravoet, and is
maintained by dataroots.
Special thanks to: