d88238c986
The README had grown to 254 lines covering an overview, every command, the Fold/SARIF and p4c import contracts, the P4 pilot, per-language resolution rules, limits, schema history, development and the agent skill. It is now a 70-line overview (what Brick is, evidence lanes, languages, quick start, commands, limits, links), and the rest lives in: - docs/usage.md: every command (build, render, check with diff and policy gates, mcp, setup), Fold/SARIF and p4c layering, the P4 pilot, and what the model contains. - docs/resolution.md: per-language name resolution as the code now implements it, what is not handled, P4 limits, the regression corpus and schema version 4. - docs/development.md: build and test commands, the quality gate, the toolchain pin, and the brick-sast skill. Architecture docs are linked, not repeated. "What v0.1 provides" and the milestone note are folded into usage.md and the roadmap pointer. Every relative link and anchor resolves.
30 lines
1 KiB
Markdown
30 lines
1 KiB
Markdown
# Development
|
|
|
|
```bash
|
|
cargo fmt --check
|
|
cargo test
|
|
cargo clippy --all-targets -- -D warnings
|
|
./scripts/quality-gate.sh
|
|
python3 tests/benchmarks/runner.py self-test
|
|
```
|
|
|
|
`scripts/quality-gate.sh` runs formatting, Clippy with warnings as errors, the
|
|
tests with and without the P4 pilot feature, the Python unit tests, and the
|
|
benchmark self-tests and runs. The repository workflow is in `AGENTS.md` and
|
|
`docs/prompts/`.
|
|
|
|
Brick pins `nightly-2026-05-28` in `rust-toolchain.toml`, matching Fold's Rust
|
|
analyzer; rustup selects it automatically for Cargo, rustfmt and Clippy inside
|
|
this repository.
|
|
|
|
## Agent skill
|
|
|
|
The evidence-aware architecture review workflow lives in `skills/brick-sast/`.
|
|
It includes a deterministic JSON summary helper and a review reference that
|
|
keeps graph observations separate from source-verified architectural
|
|
conclusions. Validate the package with:
|
|
|
|
```bash
|
|
env UV_CACHE_DIR=/private/tmp/brick-uv-cache uv run --with pyyaml \
|
|
python /path/to/skill-creator/scripts/quick_validate.py skills/brick-sast
|
|
```
|