Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.13 KB

Contributing

Thanks for your interest in deeploop!

Development setup

git clone https://github.com/VOIDXAI/deeploop.git
cd deeploop

Requirements:

  • Python 3.9+
  • bash
  • jq (used by the Stop Hook)

No pip dependencies — the project uses only the Python standard library.

Running tests

python3 -m unittest discover -s tests -p "test_*.py" -v

Linting the hook

shellcheck hooks/stop-hook.sh

Project structure

SKILL.md              # Protocol injected into Claude's prompt
references/           # Detailed specs (protocol.md, evals.md)
hooks/stop-hook.sh    # Stop Hook that drives the loop
tests/                # Unit and integration tests
benchmarks/           # Optional benchmark scripts

Guidelines

  • Keep changes focused — one concern per PR.
  • Add or update tests for any behavioral change.
  • Do not modify SKILL.md or references/ without also updating tests in test_skill_contract.py.
  • The Stop Hook must remain fast (<100 ms) — it runs on every Claude turn.

Reporting issues

Open an issue at https://github.com/VOIDXAI/deeploop/issues.