CONTRIBUTING.md

Contributing to this project

Preparing the working environment

1. Install the uv

This project is designed to work with the python package manager called uv, let's install it

2. Making venv

uv venv

3. Activating venv

# On macOS and Linux.
source .venv/bin/activate

# On Windows.
.venv\Scripts\activate

4. Installing project in development mode

uv pip install -e .[dev]

Running tests

pytest tests

Running linters

Typecheck:

mypy src/zametka/access_service

Lint

ruff check

Format

ruff format