Skip to content

🛠 Development

How to work on Khata safely: environments, testing, documentation conventions, and doc builds.

📚 Sections

Page What it covers
Environment Venv setup, deps, package layout
Testing Test layout, running, quality gates
GSDFC Docstrings The docstring & stub rules for this repo
Building Docs doc-forge lib/api/wiki/MCP builds

➕ Contributing Checklist

  1. Branch off main, keep the three-layer boundary (no backflow).
  2. Every public symbol gets a GSDFC docstring + updated .pyi stub.
  3. Wire services through init.py — do not by-pass the service registry.
  4. Run the gates: ruff check, pytest, py_compile on changed files.
  5. Regenerate docs (see Building Docs) when API/docstrings change.

Architecture · Running The Service