Skip to content

docs: add fixture guidelines for AI agents #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityathebe merged 1 commit into from
Feb 4, 2026
+11 −0
Merged

docs: add fixture guidelines for AI agents #471

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,14 @@ This repository contains documentation for multiple Flanksource projects built w
- Docs for "canary-checker", "mission-control" and shared components under `common`.
- Style enforced by Vale, markdownlint, and Prettier via Makefile targets.
- Documentation follows Google style, second person, active voice, and present tense.

## Guidelines

- Never write yaml examples directly. The examples/fixtures should come from the submodules mission-control | duty | config-db | canary-checker.
use code blocks with file=directive to import the fixtures. Example:

```yaml title="canary.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/http_simple.yaml

```

If the required fixtures aren't present then stop and notify the user.