Skip to content

Commit 8ff05bd

Browse files
authored
docs(readme): add status scope and target contribution guide (#34)
1 parent bcc2795 commit 8ff05bd

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,21 @@ Benchmark harness for framework parity and performance comparisons.
1414
- stores declarative parity fixtures and seed data
1515
- provides benchmark orchestration scripts and report generation
1616

17+
## Status & scope
18+
19+
- **Status**: Active benchmark harness with CI-enforced parity, schema checks, and quality policy checks.
20+
- **Current targets**: `modkit`, `nestjs`, `baseline`, `wire`, `fx`, `do`.
21+
- **Scope**: This repository publishes methodology, raw artifacts, and reproducible reports; it does not claim absolute winners across runtimes.
22+
- **Primary artifact entrypoints**: `results/latest/report.md` and `results/latest/summary.json`.
23+
24+
## How to contribute benchmark targets
25+
26+
1. Implement a runnable service target under the project structure used by existing adapters.
27+
2. Add or update parity fixtures in `test/fixtures/parity/` to keep behavior checks explicit.
28+
3. Validate locally with `PARITY_TARGET=http://localhost:<port> make parity-check`.
29+
4. Run benchmark flow and checks: `make benchmark`, `make report`, `make benchmark-schema-validate`, `make ci-benchmark-quality-check`.
30+
5. Open a PR with reproducibility context and generated artifact references (see `CONTRIBUTING.md` and `docs/guides/benchmark-workflow.md`).
31+
1732
## How this complements modkit
1833

1934
This repository serves as the companion performance laboratory for [go-modkit/modkit](https://github.com/go-modkit/modkit). While modkit focuses on developer ergonomics and modular architecture, this harness ensures that those abstractions do not come at the cost of performance or correctness.

0 commit comments

Comments
 (0)