33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# BeXProof Agent Guidelines
|
|
|
|
Overview
|
|
- BeXProof is a modular verifier/enforcement stack for Best Execution in equity trading. The repository hosts a production-grade MVP intended for extension by follow-on agents.
|
|
|
|
Tech Stack (initial MVP)
|
|
- Language: Python 3.9+
|
|
- Core modules: policy DSL, verifiable logs, ledger, ZKP prototype, privacy toolkit, governance, adapters
|
|
- API surface (optional later): FastAPI for internal services; wiring can be added in future tasks.
|
|
|
|
Testing & Build
|
|
- Tests are written with pytest.
|
|
- Packaging builds with setuptools via pyproject.toml/setup.py and python -m build.
|
|
- The repository includes test.sh that runs tests and packaging checks.
|
|
|
|
How to contribute (high-level rules)
|
|
- Add small, well-scoped changes; prefer minimal, correct edits.
|
|
- Write tests for new functionality; ensure tests pass locally before proposing changes.
|
|
- Update AGENTS.md with any new architectural decisions that future agents must honor.
|
|
- Do not push to remote unless explicitly requested; the orchestration layer handles publishing steps.
|
|
|
|
Repository rules
|
|
- Always start by examining the codebase with Glob and Grep (rg-based tooling).
|
|
- Use non-destructive edits; avoid altering unrelated files.
|
|
- Persist changes in this session; aim to complete a coherent feature chunk before moving to the next.
|
|
|
|
Checklist for new features
|
|
- [ ] Design a cohesive public API for the feature
|
|
- [ ] Implement minimal viable integration points
|
|
- [ ] Add unit tests that exercise core logic
|
|
- [ ] Ensure packaging/test script runs cleanly
|
|
- [ ] Document how to deploy and test the feature locally
|