docs: add AGENTS.md for AI-assisted development - #188
Conversation
|
@wangke19: GitHub didn't allow me to request PR reviews from the following users: wangke19. Note that only openshift members and repo collaborators can review this PR, and authors cannot review their own PRs. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
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 (2)
✅ Files skipped from review due to trivial changes (2)
WalkthroughAdds two new repository docs: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: wangke19 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CLAUDE.md`:
- Line 1: CLAUDE.md is currently a plain text file containing "AGENTS.md" but
must be a symbolic link to AGENTS.md for backward compatibility; delete the
existing CLAUDE.md, create a symlink named CLAUDE.md that points to AGENTS.md,
and stage the symlink in git so the repository stores the link instead of a file
(verify with a long listing showing "CLAUDE.md -> AGENTS.md").
🪄 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: 94393fd3-7854-4e49-89ee-ff50f9d08763
📒 Files selected for processing (2)
AGENTS.mdCLAUDE.md
0b25f11 to
b207bc1
Compare
Add AI assistant guidelines to help AI coding tools (Claude Code, Cursor, Copilot, etc.) understand project structure and workflows. Key sections: - Build & test commands (make targets, OTE framework) - OAuth resources (OAuthAccessToken, OAuthAuthorizeToken, User/Identity) - Token validation architecture - Code generation workflow (make update/verify) - Two-commit PR convention - Testing strategy (unit, E2E with OTE) CLAUDE.md symlinked to AGENTS.md for backwards compatibility. Reference: openshift/service-ca-operator#333
|
@wangke19: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Add AI assistant guidelines to help AI coding tools understand project structure and workflows.
What's in AGENTS.md
Structure
AGENTS.md— Main file (tool-agnostic, 94 lines)CLAUDE.md— Symlink to AGENTS.md (backwards compatibility)Why AGENTS.md?
Tool-agnostic name works with Claude Code, Cursor, Copilot, Gemini, Windsurf, etc.
Reference
Inspired by openshift/service-ca-operator#333
/cc @wangke19