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,39 +1,50 @@
|
||||
# AGENTS
|
||||
## Role
|
||||
Implement a connector for GitHub Security Advisories (GHSA) when we need to ingest GHSA content directly (instead of crosswalking via OSV/NVD).
|
||||
|
||||
## Scope
|
||||
- Determine the optimal GHSA data source (GraphQL API, REST, or ecosystem export) and required authentication.
|
||||
- Implement fetch logic with pagination, updated-since filtering, and cursor persistence.
|
||||
- Parse GHSA records (identifiers, summaries, affected packages, versions, references, severity).
|
||||
- Map advisories into canonical `Advisory` objects with aliases, references, affected packages, and range primitives.
|
||||
- Provide deterministic fixtures and regression tests for the full pipeline.
|
||||
|
||||
## Participants
|
||||
- `Source.Common` (HTTP clients, fetch service, DTO storage).
|
||||
- `Storage.Mongo` (raw/document/DTO/advisory stores and source state).
|
||||
- `Concelier.Models` (canonical advisory types).
|
||||
- `Concelier.Testing` (integration harness, snapshot helpers).
|
||||
|
||||
## Interfaces & Contracts
|
||||
- Job kinds: `ghsa:fetch`, `ghsa:parse`, `ghsa:map`.
|
||||
- Support GitHub API authentication & rate limiting (token, retry/backoff).
|
||||
- Alias set must include GHSA IDs and linked CVE IDs.
|
||||
|
||||
## In/Out of scope
|
||||
In scope:
|
||||
- Full GHSA connector implementation with range primitives and provenance instrumentation.
|
||||
|
||||
Out of scope:
|
||||
- Repo-specific advisory ingest (handled via GitHub repo exports).
|
||||
- Downstream ecosystem-specific enrichments.
|
||||
|
||||
## Observability & Security Expectations
|
||||
- Log fetch pagination, throttling, and mapping stats.
|
||||
- Handle GitHub API rate limits with exponential backoff and `Retry-After`.
|
||||
- Sanitize/validate payloads before persistence.
|
||||
|
||||
## Tests
|
||||
- Add `StellaOps.Concelier.Connector.Ghsa.Tests` with canned GraphQL/REST fixtures.
|
||||
- Snapshot canonical advisories; enable fixture regeneration with env flag.
|
||||
- Confirm deterministic ordering/time normalisation.
|
||||
# AGENTS
|
||||
## Role
|
||||
Implement a connector for GitHub Security Advisories (GHSA) when we need to ingest GHSA content directly (instead of crosswalking via OSV/NVD).
|
||||
|
||||
## Scope
|
||||
- Determine the optimal GHSA data source (GraphQL API, REST, or ecosystem export) and required authentication.
|
||||
- Implement fetch logic with pagination, updated-since filtering, and cursor persistence.
|
||||
- Parse GHSA records (identifiers, summaries, affected packages, versions, references, severity).
|
||||
- Map advisories into canonical `Advisory` objects with aliases, references, affected packages, and range primitives.
|
||||
- Provide deterministic fixtures and regression tests for the full pipeline.
|
||||
|
||||
## Participants
|
||||
- `Source.Common` (HTTP clients, fetch service, DTO storage).
|
||||
- `Storage.Mongo` (raw/document/DTO/advisory stores and source state).
|
||||
- `Concelier.Models` (canonical advisory types).
|
||||
- `Concelier.Testing` (integration harness, snapshot helpers).
|
||||
|
||||
## Interfaces & Contracts
|
||||
- Job kinds: `ghsa:fetch`, `ghsa:parse`, `ghsa:map`.
|
||||
- Support GitHub API authentication & rate limiting (token, retry/backoff).
|
||||
- Alias set must include GHSA IDs and linked CVE IDs.
|
||||
|
||||
## In/Out of scope
|
||||
In scope:
|
||||
- Full GHSA connector implementation with range primitives and provenance instrumentation.
|
||||
|
||||
Out of scope:
|
||||
- Repo-specific advisory ingest (handled via GitHub repo exports).
|
||||
- Downstream ecosystem-specific enrichments.
|
||||
|
||||
## Observability & Security Expectations
|
||||
- Log fetch pagination, throttling, and mapping stats.
|
||||
- Handle GitHub API rate limits with exponential backoff and `Retry-After`.
|
||||
- Sanitize/validate payloads before persistence.
|
||||
|
||||
## Tests
|
||||
- Add `StellaOps.Concelier.Connector.Ghsa.Tests` with canned GraphQL/REST fixtures.
|
||||
- Snapshot canonical advisories; enable fixture regeneration with env flag.
|
||||
- Confirm deterministic ordering/time normalisation.
|
||||
|
||||
## 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