Skip to content

docs: add AGENTS.md for AI-assisted development - #188

Open
wangke19 wants to merge 1 commit into
openshift:masterfrom
wangke19:add-agents-md
Open

docs: add AGENTS.md for AI-assisted development#188
wangke19 wants to merge 1 commit into
openshift:masterfrom
wangke19:add-agents-md

Conversation

@wangke19

@wangke19 wangke19 commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Add AI assistant guidelines to help AI coding tools understand project structure and workflows.

What's in AGENTS.md

  • Build & test commands: make targets, OTE framework usage
  • OAuth resources: OAuthAccessToken, OAuthAuthorizeToken, User/Identity
  • Token validation: Architecture in pkg/tokenvalidation/
  • Code generation: make update/verify workflow
  • PR conventions: Two-commit rule (code + generated/vendor)
  • Testing: Unit tests (pkg/) and E2E tests (OTE framework)

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

@openshift-ci

openshift-ci Bot commented Apr 3, 2026

Copy link
Copy Markdown

@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.

Details

In response to this:

Add AI assistant guidelines to help AI coding tools understand project structure and workflows.

What's in AGENTS.md

  • Build & test commands: make targets, OTE framework usage
  • OAuth resources: OAuthAccessToken, OAuthAuthorizeToken, User/Identity
  • Token validation: Architecture in pkg/tokenvalidation/
  • Code generation: make update/verify workflow
  • PR conventions: Two-commit rule (code + generated/vendor)
  • Testing: Unit tests (pkg/) and E2E tests (OTE framework)

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

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.

@coderabbitai

coderabbitai Bot commented Apr 3, 2026

Copy link
Copy Markdown

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8bfb41ac-bc55-4de8-96f0-3099ac427193

📥 Commits

Reviewing files that changed from the base of the PR and between b207bc1 and 63929a8.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md
✅ Files skipped from review due to trivial changes (2)
  • CLAUDE.md
  • AGENTS.md

Walkthrough

Adds two new repository docs: AGENTS.md (detailed build/test/workflow, codegen, generated-artifact rules, repo layout, and PR/commit conventions for the OAuth API Server) and CLAUDE.md (single-line reference to AGENTS.md).

Changes

Cohort / File(s) Summary
Repository docs
AGENTS.md, CLAUDE.md
Adds AGENTS.md describing build/test workflow (make build, make test-unit, make test-e2e with cluster dependency and ~3h timeout), targeted E2E invocation (make run-e2e-test WHAT=<test-name>), OTE harness usage (./oauth-apiserver-tests-ext), codegen/verify steps (make update, make verify), list of generated artifacts not to edit (conversion/deepcopy/defaults/OpenAPI), repository layout (pkg/oauth, pkg/tokenvalidation, pkg/user, pkg/externaloidc, pkg/api, test/e2e/), and PR/commit conventions (exactly two commits, category rules, branch compare against upstream/main). Adds CLAUDE.md containing the single line AGENTS.md with no trailing newline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@openshift-ci

openshift-ci Bot commented Apr 3, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: wangke19
Once this PR has been reviewed and has the lgtm label, please assign p0lyn0mial for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 29215dd and c3a4bbb.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

Comment thread CLAUDE.md
@wangke19
wangke19 force-pushed the add-agents-md branch 3 times, most recently from 0b25f11 to b207bc1 Compare April 3, 2026 15:07
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
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
@openshift-ci

openshift-ci Bot commented Apr 8, 2026

Copy link
Copy Markdown

@wangke19: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-gcp-component-serial-disruptive-ote 63929a8 link false /test e2e-gcp-component-serial-disruptive-ote
ci/prow/e2e-gcp-component-serial-ote 63929a8 link false /test e2e-gcp-component-serial-ote

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants