Skip to content

Contributing

Prerequisites

Setup

git clone https://codeberg.org/Gitznik/basst.git
cd basst
uv sync

Commands

Command Description
just test Run tests
just typecheck Run pyright
just lint Check formatting and lint rules
just fmt Auto-format and fix lint issues
just check Run lint + typecheck + test
just test-all Test against Python 3.11, 3.12, 3.13
just docs Serve docs locally

Code Style

  • Formatting/linting: ruff (config in pyproject.toml)
  • Type checking: pyright in strict mode, targeting Python 3.11
  • Docstrings: concise one-liners for public API; internal API one-liner max

Pull Requests

  1. Fork the repository
  2. Create a feature branch
  3. Make sure just check passes
  4. Open a pull request