docs: add AGENTS.md and consolidate AI agent instructions - #21
Merged
Conversation
Introduces AGENTS.md as the single source of AI agent context for this repo. Simplifies CLAUDE.md to reference it via @AGENTS.md, removes the now-redundant .github/copilot-instructions.md, and adds a per-file MD041 exemption in .rumdl.toml for CLAUDE.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Consolidates AI agent instructions into a single AGENTS.md file (per the agents.md spec), reduces CLAUDE.md to an @AGENTS.md include, and removes the now-redundant Copilot instructions file. Adds an MD041 (first-line heading) exemption for CLAUDE.md so rumdl tolerates its single-line include directive.
Changes:
- Add
AGENTS.mdas the canonical AI agent context document - Reduce
CLAUDE.mdto@AGENTS.mdand delete.github/copilot-instructions.md - Add per-file MD041 ignore for
CLAUDE.mdin.rumdl.toml
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | New consolidated agent instructions file |
| CLAUDE.md | Replaced full content with @AGENTS.md include |
| .github/copilot-instructions.md | Deleted; content now lives in AGENTS.md |
| .rumdl.toml | Adds MD041 per-file ignore for CLAUDE.md |
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
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.mdas the single source of AI agent context (compatible with agents.md spec and Claude Code's@include)CLAUDE.mdto a single@AGENTS.mdreference.github/copilot-instructions.md.rumdl.tomlforCLAUDE.md(which intentionally has no H1 heading)Test plan
rumdl .passes with no errorschezmoi diffshows no unexpected changes🤖 Generated with Claude Code