Welcome to kedro-sphinx-theme! Before contributing to the project,
make sure that you read our code of conduct (CODE_OF_CONDUCT.md).
- Clone the repository
- Set up and activate a Python development environment (advice: use venv, virtualenv, or miniconda)
- Install tox:
uv tool install tox - Make sure the tests run:
tox -e py38(change the version number according to the Python you are using) - Start a new branch:
git switch -c new-branch main - Make your code changes
- Check that your code follows the style guidelines of the project:
tox -e reformat && tox -e check - Run the tests again and verify that they pass:
tox -e py38 - (optional) Build the documentation:
tox -e docs - Commit, push, and open a pull request!