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:
@@ -1,40 +1,51 @@
|
||||
# AGENTS
|
||||
## Role
|
||||
Build the CCCS (Canadian Centre for Cyber Security) advisories connector so Concelier can ingest national cyber bulletins alongside other vendor/regional sources.
|
||||
|
||||
## Scope
|
||||
- Research CCCS advisory feeds (RSS/Atom, JSON API, or HTML listings) and define the canonical fetch workflow.
|
||||
- Implement fetch, parse, and mapping stages with deterministic cursoring and retry/backoff behaviour.
|
||||
- Normalise advisory content (summary, affected vendors/products, mitigation guidance, references, CVE IDs).
|
||||
- Emit canonical `Advisory` records with aliases, references, affected packages, and provenance metadata.
|
||||
- Provide fixtures and regression tests to keep the connector deterministic.
|
||||
|
||||
## Participants
|
||||
- `Source.Common` (HTTP clients, fetch service, DTO storage helpers).
|
||||
- `Storage.Mongo` (raw/document/DTO/advisory stores + source state).
|
||||
- `Concelier.Models` (canonical advisory data structures).
|
||||
- `Concelier.Testing` (integration fixtures and snapshot utilities).
|
||||
|
||||
## Interfaces & Contracts
|
||||
- Job kinds: `cccs:fetch`, `cccs:parse`, `cccs:map`.
|
||||
- Persist ETag/Last-Modified metadata when the upstream supports it.
|
||||
- Include alias entries for CCCS advisory IDs plus referenced CVE IDs.
|
||||
|
||||
## In/Out of scope
|
||||
In scope:
|
||||
- End-to-end connector implementation with range primitive coverage for affected packages.
|
||||
- Minimal telemetry logging/counters matching other connectors.
|
||||
|
||||
Out of scope:
|
||||
- Automated remediation actions or vendor-specific enrichment beyond CCCS published data.
|
||||
- Export or downstream pipeline changes.
|
||||
|
||||
## Observability & Security Expectations
|
||||
- Log fetch attempts, success/failure counts, and mapping statistics.
|
||||
- Sanitize HTML safely, dropping scripts/styles before storing DTOs.
|
||||
- Respect upstream rate limits; mark failures in source state with backoff.
|
||||
|
||||
## Tests
|
||||
- Add `StellaOps.Concelier.Connector.Cccs.Tests` covering fetch/parse/map with canned fixtures.
|
||||
- Snapshot canonical advisories; support fixture regeneration via env flag.
|
||||
- Validate deterministic ordering and timestamps to maintain reproducibility.
|
||||
# AGENTS
|
||||
## Role
|
||||
Build the CCCS (Canadian Centre for Cyber Security) advisories connector so Concelier can ingest national cyber bulletins alongside other vendor/regional sources.
|
||||
|
||||
## Scope
|
||||
- Research CCCS advisory feeds (RSS/Atom, JSON API, or HTML listings) and define the canonical fetch workflow.
|
||||
- Implement fetch, parse, and mapping stages with deterministic cursoring and retry/backoff behaviour.
|
||||
- Normalise advisory content (summary, affected vendors/products, mitigation guidance, references, CVE IDs).
|
||||
- Emit canonical `Advisory` records with aliases, references, affected packages, and provenance metadata.
|
||||
- Provide fixtures and regression tests to keep the connector deterministic.
|
||||
|
||||
## Participants
|
||||
- `Source.Common` (HTTP clients, fetch service, DTO storage helpers).
|
||||
- `Storage.Mongo` (raw/document/DTO/advisory stores + source state).
|
||||
- `Concelier.Models` (canonical advisory data structures).
|
||||
- `Concelier.Testing` (integration fixtures and snapshot utilities).
|
||||
|
||||
## Interfaces & Contracts
|
||||
- Job kinds: `cccs:fetch`, `cccs:parse`, `cccs:map`.
|
||||
- Persist ETag/Last-Modified metadata when the upstream supports it.
|
||||
- Include alias entries for CCCS advisory IDs plus referenced CVE IDs.
|
||||
|
||||
## In/Out of scope
|
||||
In scope:
|
||||
- End-to-end connector implementation with range primitive coverage for affected packages.
|
||||
- Minimal telemetry logging/counters matching other connectors.
|
||||
|
||||
Out of scope:
|
||||
- Automated remediation actions or vendor-specific enrichment beyond CCCS published data.
|
||||
- Export or downstream pipeline changes.
|
||||
|
||||
## Observability & Security Expectations
|
||||
- Log fetch attempts, success/failure counts, and mapping statistics.
|
||||
- Sanitize HTML safely, dropping scripts/styles before storing DTOs.
|
||||
- Respect upstream rate limits; mark failures in source state with backoff.
|
||||
|
||||
## Tests
|
||||
- Add `StellaOps.Concelier.Connector.Cccs.Tests` covering fetch/parse/map with canned fixtures.
|
||||
- Snapshot canonical advisories; support fixture regeneration via env flag.
|
||||
- Validate deterministic ordering and timestamps to maintain reproducibility.
|
||||
|
||||
## Required Reading
|
||||
- `docs/modules/concelier/architecture.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
|
||||
## Working Agreement
|
||||
- 1. Update task status to `DOING`/`DONE` in both `docs/implplan/SPRINTS.md` and the local `TASKS.md` when you start or finish work.
|
||||
- 2. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
|
||||
- 3. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
|
||||
- 4. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
|
||||
- 5. Revert to `TODO` if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.
|
||||
|
||||
Reference in New Issue
Block a user