feat: Add guild charters and task boards for various components
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Introduced guild charters for Scanner Deno, PHP, Ruby, Native, WebService, Java, Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, UI, Zastava Observer, Zastava Webhook, Zastava Core, and Plugin Platform. - Each charter outlines the mission, scope, required reading, and working agreements for the respective guilds. - Created task boards for Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, and Zastava components to track progress and dependencies. - Ensured all documents emphasize determinism, offline readiness, security, and integration with shared Surface libraries.
This commit is contained in:
27
src/Bench/StellaOps.Bench/AGENTS.md
Normal file
27
src/Bench/StellaOps.Bench/AGENTS.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Benchmarks Guild Charter
|
||||
|
||||
## Mission
|
||||
Design and maintain deterministic benchmark suites that measure StellaOps performance (queue throughput, cache efficiency, API latency) to guard SLOs and capacity plans. Benchmarks must mirror production-like workloads yet remain reproducible for local and CI runs.
|
||||
|
||||
## Scope
|
||||
- `src/Bench/StellaOps.Bench/**` benchmark harnesses, datasets, and result reporters.
|
||||
- ImpactIndex/Scheduler/Scanner/Policy Engine workload simulations referenced in tasks.
|
||||
- Benchmark configuration and warm-up scripts used by DevOps for regression tracking.
|
||||
- Documentation of benchmark methodology and expected baseline metrics.
|
||||
|
||||
## Required Reading
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- `docs/modules/scanner/architecture.md` (Scanner throughput metrics)
|
||||
- `docs/modules/scheduler/architecture.md` (ImpactIndex & planner loops)
|
||||
- `docs/modules/policy/architecture.md` (evaluation pipeline)
|
||||
- `docs/modules/telemetry/architecture.md` (metrics naming, sampling policies)
|
||||
- `docs/observability/metrics-and-slos.md` (once published)
|
||||
- Existing benchmark notes in `docs/dev/perf/` (if present) and any sprint-specific design docs referenced by TASKS.
|
||||
|
||||
## Working Agreement
|
||||
1. **State sync**: mark tasks `DOING`/`DONE` in both `docs/implplan/SPRINTS.md` and `src/Bench/StellaOps.Bench/TASKS.md` before/after work.
|
||||
2. **Baseline references**: link commits/results for baseline metrics; update docs when targets shift.
|
||||
3. **Deterministic harnesses**: avoid random seeds without explicit seeding; ensure benchmarks run offline with local fixtures.
|
||||
4. **Safety**: guard against resource exhaustion—cap concurrency, add cleanup/finalizers, ensure containerised runs have limits.
|
||||
5. **Telemetry integration**: export metrics via OpenTelemetry/Metrics APIs; coordinate with DevOps on dashboards/alerts.
|
||||
6. **Cross-guild coordination**: notify impacted component guilds when benchmarks uncover regressions; file follow-up issues with actionable data.
|
||||
Reference in New Issue
Block a user