Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (58 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

77 lines (58 loc) · 2.32 KB
Raw

Contributing

Thanks for contributing to Alice.

Scope Discipline

Keep each change narrowly scoped and avoid unrelated refactors. RULES.md defines the standing product and engineering rules.

Local Setup

make setup
make migrate
make doctor

Required Validation

Before opening a PR, run the same static, Python, LongMemEval, and web gates CI uses:

make release-static
make test-python
make test-longmemeval
make test-web
git diff --check

make test-python retains the aggregate coverage floor and enforces a ratcheted per-file floor for the production FastAPI module. make test-longmemeval is model-free and validates the checked-in compact dataset manifest even when the ignored 277 MB benchmark dataset is absent. make test-web includes unit, per-file coverage, type, lint, production build, bundle-budget, real-browser, and accessibility checks.

Changes that advertise Python 3.13 or 3.14 compatibility must also pass the representative SQLite/config/MCP functional selection under those interpreters; CI runs that matrix for every pull request.

The Postgres integration command needs the role-separated test environment documented in RELEASING.md. Run 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 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.
  • Update docs when behavior or command paths change.
  • Include exact commands executed and pass/fail evidence.
  • If browser checks fail, include the retained Playwright trace/report artifact from CI when diagnosing the failure.
  • 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