Skip to content

docs: expand AGENTS.md with entry point, config, and workflow notes#2893

Open
vimalk78 wants to merge 1 commit into
openshift:mainfrom
vimalk78:improve-claude-md
Open

docs: expand AGENTS.md with entry point, config, and workflow notes#2893
vimalk78 wants to merge 1 commit into
openshift:mainfrom
vimalk78:improve-claude-md

Conversation

@vimalk78
Copy link
Copy Markdown

Correct the MyPy "strict mode" claim, document the runner.py →
uvicorn → FastAPI startup chain and workers=1 invariant, explain the
AppConfig singleton and test reset behavior, point to README for MCP,
and add a generator + critic workflow for non-trivial changes.

Description

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change

Related Tickets & Documents

  • Related Issue #
  • Closes #

Checklist before requesting a review

  • I have performed a self-review of my code.
  • PR has passed all pre-merge test jobs.
  • If it is a core feature, I have added thorough tests.

Testing

  • Please provide detailed steps to perform tests related to this code change.
  • How were the fix/results from this change verified? Please provide relevant screenshots or results.

  Correct the MyPy "strict mode" claim, document the runner.py →
  uvicorn → FastAPI startup chain and workers=1 invariant, explain the
  AppConfig singleton and test reset behavior, point to README for MCP,
  and add a generator + critic workflow for non-trivial changes.

Signed-off-by: Vimal Kumar <vimal78@gmail.com>
@openshift-ci openshift-ci Bot requested review from bparees and joshuawilson April 16, 2026 18:28
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 16, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign joshuawilson 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

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 16, 2026

@vimalk78: all tests passed!

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.

@gkneighb
Copy link
Copy Markdown

Read through and spot-checked against the code — additions look accurate and useful. Two small things:

CLAUDE.md drift: AGENTS.md and CLAUDE.md are near-duplicates today, and this PR only touches one. The MyPy fix and the singleton/reset note will be right in AGENTS.md and stale in CLAUDE.md. Easiest: mirror these edits in CLAUDE.md too. Longer term, collapsing one into a stub pointing at the other probably makes sense, but that's a separate PR.

Generator + critic block at the bottom: the workflow itself is reasonable, but it reads a bit more "general agent advice" than the rest of the file, which is mostly project-specific facts you'd get wrong without being told. Intentional, or did it land here alongside the concrete edits? Either way is fine, just want to check.

Happy to /lgtm once the CLAUDE.md question is sorted.

@gkneighb
Copy link
Copy Markdown

Correction on the CLAUDE.md drift point in my earlier review — I missed that CLAUDE.md is already a symlink to AGENTS.md (commit 565e5db4, "moved CLAUDE.md to AGENTS.md and symlinked back per current guidelines"). Tools that read CLAUDE.md follow the symlink and get this PR's edits automatically. No mirroring needed, no drift to worry about. Apologies for the noise.

The generator+critic question stands but I'd flagged it as non-blocking either way. Content otherwise looks good.

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