Contributing

Thank you for helping improve rainlog.

Reporting issues

1. Search existing issues on Codeberg.
2. Open a new issue with rainlog --version, Python version, and steps to reproduce.

Development setup

git clone https://codeberg.org/marvin8/rainlog.git
cd rainlog
uv sync --group dev --group pytest

Checks

uv run ruff format --check src/
uv run ruff check src/
uv run ty check src/
uv run pytest tests/
uv run nox --list

Or run all sessions via Nox:

uv run nox

Documentation

• Published: https://rainlog.marvin8.zone/
• Source lives in the repository's docs/ directory.
• Configuration: mkdocs.yml at the repo root.
• Local preview:

uv sync --group dev
uv run mkdocs serve

Versioned publishing uses mike (mike deploy …) in CI on release tags, writing to the pages branch.

License

By contributing you agree your contributions are licensed under AGPL-3.0-or-later.