-
Notifications
You must be signed in to change notification settings - Fork 14
📖 add AGENTS.md #419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
📖 add AGENTS.md #419
Conversation
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
0c38454 to
a6f253e
Compare
|
/hold |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive AI agent instructions through a new AGENTS.md file, designed to help AI coding assistants (especially Code Review Bots) work more effectively with the Ironic Standalone Operator codebase.
Key Changes:
- Adds detailed project architecture documentation including CRDs, controllers, and directory structure
- Provides complete development workflow guidance with Makefile targets, hack scripts, and CI/CD references
- Documents code conventions including Go import aliases, shell script patterns, and testing guidelines
- Includes behavioral guidelines specifically for AI agents working with the codebase
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
a6f253e to
cf1dd30
Compare
Add AGENTS.md to allow AI assistants to be more effective, especially the Code Review Bot. Note: do not create .github/copilot-instructions.md as it will prevent current version of Copilot CLI from reading AGENTS.md at all. Signed-off-by: Tuomo Tanskanen <[email protected]>
bd35d7d to
985a218
Compare
|
@tuminoid: The following test failed, say
Full PR test history. Your PR dashboard. 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. |
|
I'll sort out the markdownlint in a bit. AGENTS.md is now ~100 lines, very compact. |
lentzi90
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks ok to me. I added some minor suggestions, mainly to try to reduce it a bit.
|
Oh. I started reviewing yesterday. I see you updated since then 😄 |
lentzi90
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! This I like!
Short, to the point but still providing very useful information.
/lgtm
Yeah, let's start with 100 lines (90% reduction), and amend if we find shortcomings. Sorry for making you read the old version :) |
| | `internal/controller/` | Reconciliation logic | | ||
| | `internal/webhook/` | Validation webhooks | | ||
| | `pkg/ironic/` | Core Ironic deployment logic | | ||
| | `config/` | Kustomize manifests (CRDs, RBAC, webhooks) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find it useful to highlight to the agent that these files are rarely modified directly, usually through some tag in the controller.
|
|
||
| 1. Make minimal, surgical edits | ||
| 2. Run `make generate manifests` after API changes | ||
| 3. Run `make test` before committing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also make lint please, in my experience Claude keeps forgetting it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duh, it was supposed to be there. Will fix.
Add AGENTS.md to allow AI assistants to be more effective, especially the Code Review Bot.
Note: do not create .github/copilot-instructions.md as it will prevent current version of Copilot CLI from reading AGENTS.md at all.