CONTRIBUTING.md

Contribute to CacheYou

Project Management

The CacheYou project is managed by PDM. You need to install it first:

pipx install pdm

For other installation methods, please refer to PDM's documentation.

After the installation, initialize the plugins and install the dependencies:

pdm install --plugins
pdm install

Run the Tests

We use tox to run the tests. You can run the tests by:

pdm run tox

View the available environments and pick one to run:

pdm run tox -l

You can also run pytest directly in the project environment by:

pdm test

Watch the Docs

Run the following command to start a live-reloading docs server:

pdm docs

Code Style and Linters

We use Black to format the code and Ruff as the linter. They are all integrated into pre-commit. You can enable it by:

pre-commit install

and run the checks by:

pre-commit run --all-files

Create a Release

Before releasing, make sure you add the change summary to the docs/release_notes.rst file. Then, run the following command to create a release and corresponding tag commit:

pdm release

For simplicity, we use a version schema of YY.BUILD_NUMBER, where YY is the last two digits of the current year and BUILD_NUMBER increases by one for each release.