Added AGENTS.md with instructions for coding agents#609
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAGENTS.md is added as a comprehensive contributor guide for AI coding agents; CLAUDE.md is updated to point agents to AGENTS.md and to forbid implementation details. The docs cover repo layout, workflows (build/test/codegen/Kind), the five-phase authorisation pipeline, working-memory shape, evaluator wiring, testing, logging, flags and API-version notes. ChangesAI Agent Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 13-36: Update the fenced repository tree block that currently
starts with ``` followed by the "authorino/" directory listing to include a
language identifier (e.g., change the opening fence from ``` to ```text) so the
code fence is annotated and markdownlint MD040 is satisfied.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Pull request overview
Adds a new root-level AGENTS.md intended to provide tool-agnostic guidance for AI coding agents working in the Authorino repository, complementing the existing agent-specific guidance files (e.g., CLAUDE.md).
Changes:
- Introduces
AGENTS.mddescribing project purpose, repo layout, and key development commands. - Documents core mental models (auth pipeline phases, “authorization JSON”) to orient changes to evaluators/controllers.
- Adds agent-focused guardrails (codegen warnings, logging/sensitive data guidance, common anti-patterns).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
muskiteer
force-pushed
the
docs/added-agents-md-564
branch
from
c22e5ea to
d6a9264
Compare
muskiteer
force-pushed
the
docs/added-agents-md-564
branch
from
66dd71b to
e9bac49
Compare
|
Thanks @muskiteer! I think in general having Here's my proposal: we should synthesise these two files into one and turn the other into a symlink. This way, it will be easier to maintain, and what's equality important these days: less tokens to process 🙂 If you would like to take a shot at this, I'll be happy to review your PR. |
|
Sorry for the late reply @guicassolato.Happy to take this on |
That's right, @muskiteer. Thanks for taking this on! |
|
I studied the requirements for agents.md and the current claude.md. The major gaps I noticed in claude.md are the lack of a proper project structure section and a contributing guide. |
Signed-off-by: muskiteer <agarwal.vansh3110@gmail.com>
muskiteer
force-pushed
the
docs/added-agents-md-564
branch
from
e757c33 to
66db3b0
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Line 3: Update the opening statement in AGENTS.md to be tool-agnostic: replace
the Claude-specific sentence ("This file provides guidance to Claude Code
(claude.ai/code) when working with code in this repository.") with a generic
phrasing such as "This file provides guidance to AI assistants when working with
code in this repository, including architecture, developer workflow, tests, and
contribution instructions." Ensure the new sentence appears at the top of
AGENTS.md and preserves the intent referenced in the comment.
- Line 192: Typo in the documentation: replace the incorrect field path
`spec..cache` with the correct `spec.cache` everywhere it appears (e.g., in the
guidance sentence "Each evaluator can use `spec..cache` for instance-level
caching"); update any surrounding examples or references that use `spec..cache`
to `spec.cache` to avoid confusion for implementers.
- Line 241: Replace the non-standard reference "`@docs/contributing.md`" with a
valid Markdown file link (for example "docs/contributing.md" or
"./docs/contributing.md" or the correct repo path like "CONTRIBUTING.md") in the
sentence "See the full Developer's Guide in `@docs/contributing.md` for" so the
link resolves when the docs are rendered.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4cefcbc0-e92f-430d-ad1d-2d42f6043696
📒 Files selected for processing (2)
AGENTS.mdCLAUDE.md
✅ Files skipped from review due to trivial changes (1)
- CLAUDE.md
Signed-off-by: muskiteer <agarwal.vansh3110@gmail.com>
|
Added repository map and contribution guide to AGENTS.md; remaining content mirrors CLAUDE.md. |
Add
AGENTS.md— Universal AI Agent GuidanceWhat this PR does
Adds an
AGENTS.mdfile to the repository root, providing guidance for AI coding agents (GitHub Copilot, Cursor, Gemini Code Assist, Claude Code, etc.) working with the Authorino codebase.Why
The existing
CLAUDE.mdis great but is scoped specifically to Claude Code.AGENTS.mdserves as a tool-agnostic equivalent that any AI assistant can pick up automatically, following the emerging convention of agent-readable context files at the repo root.What's included
make generate && make manifestsmust be run after any changes toapi/No functional changes
This PR adds documentation only. No source code, tests, or manifests are modified.
Closes #564
Summary by CodeRabbit