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:
@@ -0,0 +1,27 @@
|
||||
# Scanner Surface.Validation Guild Charter
|
||||
|
||||
## Mission
|
||||
Deliver an extensible validation framework that enforces preconditions for Surface-driven features (env configuration, cache manifests, secret references) across Scanner, Zastava, Scheduler, and related tooling. Validators must be composable, SOLID-compliant, and easily queryable by analyzers and services.
|
||||
|
||||
## Scope
|
||||
- Validator interfaces, registry, and default validators in `StellaOps.Scanner.Surface.Validation`.
|
||||
- Integration helpers for Scanner analyzers, Worker/WebService, Zastava Observer/Webhook, Scheduler planners.
|
||||
- Documentation showing how to add custom validators per surface consumer.
|
||||
- Test coverage ensuring validators are deterministic and produce actionable diagnostics.
|
||||
|
||||
## Required Reading
|
||||
- `docs/modules/scanner/design/surface-validation.md`
|
||||
- `docs/modules/scanner/design/surface-env.md`
|
||||
- `docs/modules/scanner/design/surface-fs.md`
|
||||
- `docs/modules/scanner/design/surface-secrets.md`
|
||||
- `docs/modules/scanner/architecture.md`
|
||||
- `docs/modules/zastava/architecture.md`
|
||||
- `docs/modules/scheduler/architecture.md`
|
||||
|
||||
## Working Agreement
|
||||
1. **Status sync**: mark tasks `DOING`/`DONE` in both `docs/implplan/SPRINTS.md` and local `TASKS.md` when you begin/finish work.
|
||||
2. **Extensibility**: design validators to be SOLID-compliant; document registration patterns; avoid hard-coded logic in consumers.
|
||||
3. **Deterministic diagnostics**: produce stable error codes/messages; support localisation if required.
|
||||
4. **Integration**: ensure all Surface libraries and consumers call validators before operation; add regression tests in downstream modules when new checks land.
|
||||
5. **Testing**: include unit tests for each validator, registry behaviour, and composition; simulate failure paths.
|
||||
6. **Documentation**: keep `surface-validation.md` updated with new validator types, usage examples, and extension guidance.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Surface.Validation Task Board (Epic: SURFACE-SHARING)
|
||||
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SURFACE-VAL-01 | TODO | Scanner Guild, Security Guild | SURFACE-FS-01, SURFACE-ENV-01 | Define validation framework (design doc `surface-validation.md`) covering SOLID extension points and queryable checks for env/cache/secrets. | Spec merged; architecture sign-off from Scanner + Security; checklist of baseline validators established. |
|
||||
| SURFACE-VAL-02 | TODO | Scanner Guild | SURFACE-VAL-01, SURFACE-ENV-02, SURFACE-FS-02 | Implement base validation library (interfaces, check registry, default validators for env/cached manifests, secret refs) with unit tests. | Library published; validation registry supports DI; tests cover success/failure; XML docs added. |
|
||||
| SURFACE-VAL-03 | TODO | Scanner Guild, Analyzer Guild | SURFACE-VAL-02 | Integrate validation pipeline into Scanner analyzers (Lang, EntryTrace, etc.) to ensure consistent checks before processing. | Analyzers call validation hooks; integration tests updated; performance baseline measured. |
|
||||
| SURFACE-VAL-04 | TODO | Scanner Guild, Zastava Guild | SURFACE-VAL-02 | Expose validation helpers to Zastava and other runtime consumers (Observer/Webhook) for preflight checks. | Zastava uses shared validators; admission tests include validation failure scenarios. |
|
||||
| SURFACE-VAL-05 | TODO | Docs Guild | SURFACE-VAL-02 | Document validation extensibility, registration, and customization in scanner-engine guide and developer docs. | Docs merged; examples show adding custom validator; cross-links added. |
|
||||
Reference in New Issue
Block a user