Welcome to the prettypyplot
Contributing Guide¶
This guide will give you an overview of the contribution workflow from opening an issue and creating a PR. To get an overview of the project, read the module overview.
Issues¶
Create a new issue¶
If you spot a bug, want to request a new functionality, or have a question on how to use the module, please search if an issue already exists. If a related issue does not exist, feel free to open a new issue.
Solve an issue¶
If you want to contribute and do not how, feel free to scan through the existing issues.
Create a new pull request¶
Create a fork¶
If you want to request a change, you first have to fork the repository.
Setup a development environment¶
First you need to install uv
. Please follow the installation instruction provided on their page docs.astral.sh/uv.
# setup venv
uv sync --all-groups
# install pre-commit
uv run pre-commit install
Make changes and run tests¶
Apply your changes and check if you followed the codeing style (PEP8) by running
uv run check --format
All errors pointing to ./build/
can be neglected, they are caused by my lazy approach of using no wildcards in the setup.
If you add a new function/method/class please ensure that you add a test function, as well. Running the test simply by
# run tox
uv run tox
# or run it in parallel to speed it up
uv run tox run-parallel
Open a pull request¶
Now you are ready to open a pull request and wait on feedback.