stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 12 Releases Wiki Activity
Files
main
git.stella-ops.org/samples/AGENTS.md
master 90c244948a Update AGENTS.md files across multiple modules to standardize task status update instructions and introduce a new document for Secret Leak Detection operations. 
- Modified task status update instructions in AGENTS.md files to refer to corresponding sprint files as `/docs/implplan/SPRINT_*.md` instead of `docs/implplan/SPRINTS.md`.
- Added a comprehensive document for Secret Leak Detection operations detailing scope, prerequisites, rule bundle lifecycle, enabling the analyzer, policy patterns, observability, troubleshooting, and references.
2025-11-05 11:58:32 +02:00

2.0 KiB
Raw Permalink Blame History

Samples Guild Charter

Mission

Curate and maintain deterministic sample assets (configs, fixtures, walkthrough projects) that demonstrate StellaOps capabilities across modules. Samples must stay aligned with current APIs, schemas, and offline workflows so other guilds can rely on them for documentation, demos, and regression tests.

Scope

  • Own sample bundles under samples/ (configuration packs, walkthrough datasets, tutorial projects).
  • Keep sample instructions in sync with latest component behaviour (Policy Engine, Scanner, CLI, UI, Offline Kit).
  • Provide reproducible scripts to set up, execute, and validate each sample.
  • Coordinate with Docs and DevRel to surface sample updates.

Required Reading

  • docs/README.md
  • docs/quickstart.md
  • docs/09_API_CLI_REFERENCE.md
  • docs/modules/platform/architecture-overview.md
  • docs/modules/cli/architecture.md
  • docs/modules/ui/architecture.md
  • docs/modules/scanner/architecture.md
  • docs/modules/policy/architecture.md
  • docs/modules/export-center/architecture.md
  • docs/modules/telemetry/architecture.md (for observability-focused samples)

Working Agreement

  1. Before starting a task update its status to DOING in both corresponding sprint file docs/implplan/SPRINT_*.md and samples/TASKS.md. Revert to TODO if you pause, or DONE when complete.
  2. Review this charter & required docs to confirm conventions (deterministic outputs, offline readiness, security posture) before coding.
  3. Preserve determinism: scripts must pin versions, normalise timestamps, and avoid network calls beyond documented mirrors.
  4. Documentation parity: every change to a sample must include README/guide updates explaining execution steps and expected results.
  5. Cross-guild sign-off: if a sample depends on another module (e.g., Policy, Scanner), sync with that guild before changing APIs or fixtures.
  6. Telemetry & cleanup: ensure sample scripts clean up resources and redact secrets; include telemetry hints where valuable for users.