Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (48 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 1.73 KB

Contributing

Thanks for contributing to Alice.

Scope Discipline

This repo enforces sprint-scoped delivery. Keep changes aligned to active sprint packet and avoid unrelated refactors.

Local Setup

cp .env.example .env
python3 -m venv .venv
./.venv/bin/python -m pip install -e '.[dev]'
docker compose up -d
./scripts/migrate.sh
./scripts/load_sample_data.sh

Required Validation

Before opening a PR, run:

python3 scripts/check_control_doc_truth.py
./.venv/bin/python -m pytest tests/unit -q
pnpm --dir apps/web test
pnpm --dir apps/web build
git diff --check

Run integration and bridge checks when the change touches those surfaces:

./.venv/bin/python -m pytest tests/integration -q
./.venv/bin/python scripts/run_hermes_memory_provider_smoke.py
./.venv/bin/python scripts/run_hermes_mcp_smoke.py
./.venv/bin/python scripts/run_hermes_bridge_demo.py

For vNext connector changes:

./.venv/bin/python -m pytest tests/unit/test_vnext_connectors.py -q
./.venv/bin/python -c 'from alicebot_api.cli import main; raise SystemExit(main(["vnext", "connectors", "list"]))'

Pull Request Expectations

  • Keep PR scope narrow and sprint-aligned.
  • Update docs when behavior or command paths change.
  • Include exact commands executed and pass/fail evidence.
  • Complete the protected-path Upgrade Overview when the PR touches paths listed in PROTECTED_PATHS.md.
  • Do not introduce claims that outrun shipped functionality.
  • Use synthetic fixtures only for public demo data.

Architecture and Rules

Read before making non-trivial changes:

  • ARCHITECTURE.md
  • RULES.md
  • PROTECTED_PATHS.md
  • docs/vnext/contributor-guide.md
  • active sprint packet (internal/local-only; not published in this repo)