Files
git.stella-ops.org/docs/modules/graph/AGENTS.md
master 2de8d1784b
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
new advisories
2025-11-23 23:38:25 +02:00

2.4 KiB

Graph agent guide

Mission

Graph module (upcoming) will power graph-indexed queries for SBOM relationships, lineage, and blast-radius analysis.

Advisory Handling

  • Any new/updated advisory triggers doc + sprint updates immediately. No approval.
  • Update high-level + detailed docs; inline only short snippets; runnable/long code to docs/benchmarks/** or tests/** (deterministic/offline) with links.
  • Add tasks and Execution Log entries in relevant SPRINT_*.md with doc paths/owners; add risks if schema/feed/transparency caps apply.
  • Check archived advisories for overlap; mark supersedes/extends.
  • Defaults: hybrid reachability posture, deterministic/frozen feeds; execute first, report after.

Key docs

How to get started

  1. Open sprint file /docs/implplan/SPRINT_*.md and locate the stories referencing this module.
  2. Review ./TASKS.md for local follow-ups and confirm status transitions (TODO → DOING → DONE/BLOCKED).
  3. Read the architecture and README for domain context before editing code or docs.
  4. Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.

Guardrails

  • Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
  • Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
  • Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
  • Update runbooks/observability assets when operational characteristics change.

Required Reading

  • docs/modules/graph/README.md
  • docs/modules/graph/architecture.md
  • docs/modules/graph/implementation_plan.md
  • docs/modules/platform/architecture-overview.md

Working Agreement

    1. Update task status to DOING/DONE in both correspoding sprint file /docs/implplan/SPRINT_*.md and the local TASKS.md when you start or finish work.
    1. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
    1. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
    1. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
    1. Revert to TODO if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.