Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (34 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.59 KB
Raw

Contributing to Azazel-Edge

Before you start

Read AGENTS.md first. It defines the design principles, layer rules, and what must not be changed.

Branch naming

<type>/<short-description>

Examples: feat/decision-trust-capsule, fix/epd-help-crash, docs/readme-reorganize

Commit message format

<type>(<scope>): <summary>

  • type: feat / fix / refactor / test / docs / chore / security
  • scope: arbiter / evaluator / evidence / ai / web / rust / runbook / installer / notify / audit / demo / mio

Pull request rules

  • 1 PR = 1 purpose. Do not mix unrelated changes.
  • Every PR must include:
    • PYTHONPATH=. pytest -q passes
    • cd rust/azazel-edge-core && cargo test passes (if Rust touched or validation scope includes Rust)
    • Related documentation updated in the same PR
    • If API surface or runtime configuration changed, update docs/API_REFERENCE.md and/or docs/CONFIGURATION.md in the same PR
    • Deterministic First principle not violated
    • Raspberry Pi constraints not broken

What not to do (requires human review)

See AGENTS.md §3.4 for the full list. The short version:

  • Do not touch installer/, systemd/, or security/ without explicit approval
  • Do not set AZAZEL_AUTH_FAIL_OPEN=1 or AZAZEL_DEFENSE_ENFORCE=true
  • Do not disable requires_approval on any Runbook

Testing

python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements/dev.txt
PYTHONPATH=py:. .venv/bin/pytest -q
cd rust/azazel-edge-core && cargo test

# unified helper
bin/azazel-edge-dev test-all