Contributing

Your contributions are highly appreciated!

Installation and Setup

Clone your fork and cd into the repo directory

git clone git@github.com:<your username>/TimeCopilot.git
cd TimeCopilot

Install uv, and pre-commit:

• uv install docs
• pre-commit install docs

Tip

Once uv is installed, to install pre-commit you can run the following command:

uv tool install pre-commit

Install the required libraries for local development

uv sync --frozen --all-extras --all-packages --group docs

Install pre-commit hooks

pre-commit install --install-hooks

You're ready to start contributing!

Running Tests

To run tests, run:

uv run pytest

Documentation Changes

To run the documentation page locally, run:

uv run mkdocs serve