📖 add AGENTS.md

[tuminoid]

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.

[metal3-io-bot]

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]

[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 kashifest for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

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

[tuminoid]

/hold
Iterating this in all repos.

[Copilot]

Pull request overview

This PR adds comprehensive documentation for AI coding agents working on the Cluster API Provider Metal3 (CAPM3) project. The new AGENTS.md file serves as a detailed reference guide that can be used by AI assistants (including GitHub Copilot and other AI coding tools) to better understand the project's architecture, conventions, and workflows.

Key changes:

• Comprehensive 1,488-line AGENTS.md file documenting project structure, development workflows, testing guidelines, and coding conventions
• .github/copilot-instructions.md file that references AGENTS.md using the @ syntax
• .gitignore entry for .claude directory to exclude AI assistant configuration files

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File	Description
AGENTS.md	New comprehensive AI agent documentation covering architecture, Makefile targets, CI/CD, code patterns, testing guidelines, E2E testing details, and behavioral guidelines
.gitignore	Adds exclusion for .claude directory used by AI assistant configurations
.github/copilot-instructions.md	References AGENTS.md to provide context to GitHub Copilot

---

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

[tuminoid]

I wonder if the Copilot review would pick it up from PR, now that the copilot-instructions.md mess is cleared up.

[tuminoid]

/cc @lentzi90

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.