Add AI agent guidance (AGENTS.md) and CLAUDE.md symlink#62
Merged
chadcrum merged 4 commits intoJun 22, 2026
Merged
Conversation
Add AGENTS.md with enhancement authoring guidelines for AI coding agents, covering template structure, frontmatter validation, formatting, spelling, review process, level-of-detail rules with before/after examples, and writing guidelines derived from reviewing all 18 existing enhancements. CLAUDE.md is symlinked to AGENTS.md for Claude Code compatibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Chad Crum <chadcrum@users.noreply.github.com>
chadcrum
requested review from
Fale,
croadfeldt,
gabriel-farache,
gciavarrini,
jenniferubah,
machacekondra and
pkliczewski
as code owners
gciavarrini
reviewed
Jun 19, 2026
Slash commands (/lgtm, /approve) only post reminders — they don't perform real actions. Removed per reviewer feedback. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Chad Crum <chadcrum@users.noreply.github.com>
Per reviewer feedback — the Summary is the first section readers see and should be clear, concise, and consistent across enhancements. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Chad Crum <chadcrum@users.noreply.github.com>
gabriel-farache
approved these changes
Jun 22, 2026
gabriel-farache
left a comment
gabriel-farache
left a comment
Collaborator
There was a problem hiding this comment.
let's start with this and adjustments will be made if/when necessary
gciavarrini
approved these changes
Jun 22, 2026
gciavarrini
left a comment
gciavarrini
left a comment
Collaborator
There was a problem hiding this comment.
lgtm, after dropping the test plan section
Test plans are derived during implementation — the section added no value to enhancement documents. Removed per reviewer consensus. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Chad Crum <chadcrum@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdwith instructions for AI coding agents to produce conformant enhancement documents — covers template structure, formatting/spelling rules, level-of-detail guidance, and writing conventions derived from reviewing all 18 existing enhancementsCLAUDE.mdas a symlink toAGENTS.md(Claude Code doesn't readAGENTS.mdnatively, so the symlink keeps both tools in sync with zero drift)kubevirtandvirtualmachinestocspell.yamldictionaryAGENTS.mdis a cross-tool open standard recognized by Cursor, Codex, Copilot, Gemini CLI, Aider, Windsurf, and Zed. It supplementsREADME.mdwithout duplicating it — README covers what qualifies as an enhancement and the contribution workflow, whileAGENTS.mdadds the specifics agents need to get the output right (frontmatter validation, section ordering, appropriate level of abstraction, etc.).Writing guidelines were derived by having three independent reviewers (QE, architecture, staff engineering perspectives) scan all existing enhancements to identify common patterns and anti-patterns.
Jira: FLPATH-4411
🤖 Generated with Claude Code