Repository navigation
docs: add AGENTS.md and CLAUDE.md for agent guidance - #38
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds agent-facing repository guidance by introducing a comprehensive AGENTS.md (tech stack, repo layout, codegen boundaries, dev commands, verification steps, and key RuboCop rules) and a lightweight CLAUDE.md pointer so agent tooling can quickly discover the guidance entrypoint.
Changes:
- Add
AGENTS.mdwith repo-specific development and contribution guidance. - Add
CLAUDE.mdthat links toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| AGENTS.md | Introduces detailed agent guidance for working effectively in this repo (stack, structure, generation boundaries, commands, verification, lint rules). |
| CLAUDE.md | Provides a single pointer to AGENTS.md for agent discovery. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
carlastabile
approved these changes
Jul 1, 2026
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.mdwith guidance for agents working in this repo: tech stack, project structure, code generation notes (auto-generated vs hand-maintained files), architecture overview, development commands, verification requirements, commit conventions, and key RuboCop rules with examplesCLAUDE.mdthat points toAGENTS.mdTest plan
AGENTS.mdfor accuracy against current repo stateCLAUDE.mdrenders correctly and the link resolves