docs: improve AGENTS.md and DEVELOPMENT.md guidance for AI agents#8703
docs: improve AGENTS.md and DEVELOPMENT.md guidance for AI agents#8703cssjr wants to merge 6 commits into
Conversation
…to DEVELOPMENT.md Add content that was lost during the AGENTS.md restructuring in openshift#8690: - Single unit test and envtest invocation commands - Envtest single-version and parallel execution examples - make verify-codespell, make run-gitlint, and expanded make verify description - make generate stale mock cleanup note - Jira integration section (CNTRLPLANE vs OCPBUGS projects, component selection) - Inlined conventional commit format template with types and line limits Signed-off-by: Cliff Schomburg <cschombu@redhat.com>
…d symlink Signed-off-by: Cliff Schomburg <cschombu@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- api/AGENTS.md: correct karpenter example path from v1beta1 to v1 - ARCHITECTURE.md: add GCP to platform list - control-plane-operator/AGENTS.md: update component count from ~30 to ~40 - DEVELOPMENT.md: fix skill name to restructure-commits, correct make pre-commit description, soften Signed-off-by language Signed-off-by: Cliff Schomburg <cschombu@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add Contributing and Pre-commit hooks entries to the AGENTS.md key references table. Add Pre-PR Gate and Go Version sections to DEVELOPMENT.md so developers discover `make pre-commit` and the Go 1.25+ requirement without digging through other files. Signed-off-by: Cliff Schomburg <cschombu@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Cliff Schomburg <cschombu@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: cssjr 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 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR updates five documentation files across the repository to clarify AI agent guidance, expand developer contribution workflow instructions, document platform support, and adjust component inventory metrics. AGENTS.md was rewritten to explicitly note the CLAUDE.md symlink and emphasize minimal intentional scope with references to ARCHITECTURE.md; its Key References section was extended with links to CONTRIBUTING.md and pre-commit documentation. DEVELOPMENT.md received substantial additions including targeted testing instructions, clarified make-target behaviors, new pre-PR gate requirements, expanded gotchas guidance, and revised commit restructuring references. ARCHITECTURE.md added GCP to the platform support list. API and operator-specific documentation were updated to reflect the current Karpenter v1 API reference and adjusted component counts to ~40 for the control-plane-operator. Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 7❌ Failed checks (7 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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 |
|
/area ai |
|
/assign @bryan-cox |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8703 +/- ##
=======================================
Coverage 41.50% 41.50%
=======================================
Files 758 758
Lines 93689 93689
=======================================
Hits 38882 38882
Misses 52070 52070
Partials 2737 2737
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@cssjr: all tests passed! 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. |
Summary
30→40, add missing GCP platform)Test plan
make verifyrequired🤖 Generated with Claude Code
Summary by CodeRabbit