Skip to content

contributing.md

Latest commit

 

History

History
84 lines (59 loc) · 2.13 KB

contributing.md

File metadata and controls

84 lines (59 loc) · 2.13 KB
Raw

Contributing

Welcome — this project is steered by the Active Inference Institute and welcomes contributions from researchers, engineers, and AI agents alike.

TL;DR

  1. Open or comment on an issue describing what you want to do.
  2. Fork → branch → code → test → PR.
  3. Run uv run python scripts/release_check.py before pushing.
  4. Keep PRs scoped: one logical change per PR.

Detailed flow

1. Set up (uv)

git clone https://github.com/<you>/ActiveBlockference.git
cd ActiveBlockference
uv venv --python 3.11
uv pip install -e ".[dev,docs]"
uv sync --locked --extra dev
uv run pytest --cov=blockference --cov-fail-under=90

2. Branch

git checkout -b feat/<short-description>
# or fix/<...>, docs/<...>, refactor/<...>

3. Write code + tests together

  • Library code lives in blockference/.
  • Tests live in tests/ and mirror the package layout.
  • Notebooks in notebooks/ are for exploration; promote stable code into the package.

4. Format and lint

uv run ruff format blockference tests
uv run ruff check  blockference tests

5. Document

If you change a public surface, update:

  • The relevant module docstring.
  • docs/api.md.
  • docs/architecture.md if you change layering.
  • The folder-local README.md table.

6. Open the PR

Describe the change, motivation, and verification in the pull request conversation. Include pytest output and screenshots when visual behaviour changed.

A reviewer will look at correctness, scope, and doc/test parity.

Folder ownership

See the table in the root AGENTS.md. Each folder also ships its own AGENTS.md with local rules.

Reporting issues

Open at https://github.com/ActiveInferenceInstitute/ActiveBlockference/issues with:

  • Reproducer (minimal Python snippet or notebook cell).
  • Expected vs. observed behaviour.
  • Versions (python -V, pip show cadCAD radcad). pymdp is optional and should be reported only when the adapter extra is being debugged.

Code of conduct

Be kind. Default to assuming good faith. This community values rigour and warmth — both are required.