Imported from ActiveInferenceInstitute/cognitive (
docs/development/AGENTS.md). Install upstream withnpx skills add ActiveInferenceInstitute/cognitive --skill development. Copyright stays with the author.
Development documentation instructions
The development documentation records how to work on this repository: the development loop, quality gates, and conventions. It does not describe automated development agents.
Development loop
python -m pip install -e ".[dev]"
python -m pytest -q --cov
ruff check .
mypy code/tools/src code/Things code/scripts
python -m compileall -q code
python code/scripts/validate_docs.py --json
python code/scripts/verify_links.py . --json
The complete loop, including the manuscript build, benchmark, and mutation
check, is in docs/development/README.md.
Conventions
- Python: snake_case, type hints, docstrings on public methods, ruff for lint and format (project style, no black).
- Documentation: every content folder has an
AGENTS.md(instructions) and aREADME.md(overview/navigation); YAML frontmatter is required on Markdown files; internal cross-references use[[wiki links]]. - Tests: real data and computation, no fixture-only assertions; tests write artifacts only to temporary directories.
Rules
- Update
docs/development/README.mdwhen the tooling or gate commands change. - Do not document fictional development workflows or agent frameworks; the
repository's actual tooling lives in
code/scripts/and the installed CLI entry points.
