Skip to content

📖 add AGENTS.md #2763

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.

Sign up for GitHub

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

Jump to bottom
Merged
metal3-io-bot merged 1 commit into from
Dec 10, 2025
Merged

📖 add AGENTS.md #2763

metal3-io-bot merged 1 commit into from
Dec 10, 2025

Conversation

@tuminoid
Copy link
Member

@tuminoid tuminoid commented Nov 5, 2025 •
edited
Loading

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.

CLAUDE.md symlink is needed until Claude supports AGENTS.md.

@metal3-io-bot
Copy link
Contributor

metal3-io-bot commented Nov 5, 2025

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@metal3-io-bot metal3-io-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 5, 2025
@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 5, 2025
@tuminoid tuminoid force-pushed the tuomo/add-copilot-instructions branch from ee9fd30 to 727eee2 Compare November 26, 2025 13:56
@tuminoid tuminoid changed the title add copilot-instructions.md 📖 add AGENTS.md Nov 26, 2025
@metal3-io-bot metal3-io-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 26, 2025
@tuminoid tuminoid marked this pull request as ready for review November 26, 2025 13:56
@metal3-io-bot metal3-io-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 26, 2025
@tuminoid
Copy link
Member Author

tuminoid commented Nov 26, 2025

/hold
Iterating in multiple repos. Reviews welcome.

@metal3-io-bot metal3-io-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 26, 2025
@tuminoid tuminoid requested a review from Copilot November 26, 2025 14:09
Copilot AI reviewed Nov 26, 2025
View reviewed changes
Copy link

Copilot AI left a 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 a comprehensive AGENTS.md file to provide AI coding assistants with detailed instructions for working effectively on the Metal3 Baremetal Operator project. The document serves as a complete reference guide for AI agents to understand the project architecture, development workflows, conventions, and best practices.

  • Comprehensive documentation covering architecture, CRDs, controllers, provisioners, and state machines
  • Complete Makefile and hack scripts reference with detailed explanations
  • CI/CD pipeline documentation including GitHub Actions and Prow workflows
  • Development guidelines including code patterns, testing frameworks, and commit conventions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tuminoid tuminoid force-pushed the tuomo/add-copilot-instructions branch 2 times, most recently from 02804b7 to 887a04a Compare December 2, 2025 21:38
@metal3-io-bot metal3-io-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 2, 2025
@tuminoid
Copy link
Member Author

tuminoid commented Dec 2, 2025

Revised and truncated A LOT. I'll handle the markdownlint in another PR.

@MahnoorAsghar
Copy link
Contributor

MahnoorAsghar commented Dec 5, 2025

@tuminoid It just looks like 2 small failures for markdownlint, why another PR? 🤔

@tuminoid
Copy link
Member Author

tuminoid commented Dec 5, 2025 •
edited
Loading

@tuminoid It just looks like 2 small failures for markdownlint, why another PR? 🤔

I intend to allow long lines in code fences and tables, which are constant pain in the ... for everyone and then cleanup the unnecessary ignores. I don't want to mix it or add to it in this PR. The same standard needs to apply in all repos.

@tuminoid
add AGENTS.md
3e58436 
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]>
@tuminoid tuminoid force-pushed the tuomo/add-copilot-instructions branch from 887a04a to 3e58436 Compare December 9, 2025 08:36
@tuminoid
Copy link
Member Author

tuminoid commented Dec 9, 2025

This should be fine now.
/unhold
/cc @lentzi90 @Rozzii @kashifest

@metal3-io-bot metal3-io-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 9, 2025
@tuminoid tuminoid requested a review from Copilot December 9, 2025 08:41
Copilot AI reviewed Dec 9, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

kashifest
kashifest reviewed Dec 9, 2025
View reviewed changes
Copy link
Member

@kashifest kashifest left a comment

Choose a reason for hiding this comment

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

/approve

@metal3-io-bot
Copy link
Contributor

metal3-io-bot commented Dec 9, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kashifest

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

The pull request process is described 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

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 9, 2025
lentzi90
lentzi90 reviewed Dec 10, 2025
View reviewed changes
Copy link
Member

@lentzi90 lentzi90 left a comment

Choose a reason for hiding this comment

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

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 10, 2025
@metal3-io-bot metal3-io-bot merged commit cb8392c into metal3-io:main Dec 10, 2025
20 checks passed
@metal3-io-bot metal3-io-bot deleted the tuomo/add-copilot-instructions branch December 10, 2025 06:34
@metal3-io-bot metal3-io-bot added this to the BMO - v0.12 milestone Dec 10, 2025
@dtantsur dtantsur mentioned this pull request Dec 10, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kashifest kashifest kashifest left review comments

Copilot code review Copilot Copilot left review comments

@iurygregory iurygregory Awaiting requested review from iurygregory

@zaneb zaneb Awaiting requested review from zaneb

@dtantsur dtantsur Awaiting requested review from dtantsur

@peppi-lotta peppi-lotta Awaiting requested review from peppi-lotta

@Rozzii Rozzii Awaiting requested review from Rozzii

+1 more reviewer

@lentzi90 lentzi90 lentzi90 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

BMO - v0.12

Development

Successfully merging this pull request may close these issues.

5 participants

@tuminoid @metal3-io-bot @MahnoorAsghar @lentzi90 @kashifest