Skip to content

Conversation

joelanford
Copy link
Member

Description

In order for maintainers and external developers to have a tailored experience using AI development tools, it is helpful to include an AGENTS.md file in the repo to guide AI agents in their tasks.

I used Claude Code to generate the AGENTS.md file in this PR.

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 16, 2025
Copy link

openshift-ci bot commented Oct 16, 2025

[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 joelanford 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:

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

Copy link

netlify bot commented Oct 16, 2025

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 0348a8e
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/68f130f25d9302000895f800
😎 Deploy Preview https://deploy-preview-2274--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@joelanford joelanford changed the title Add AGENTS.md to assist AI agents interacting with this repository 🌱 Add AGENTS.md to assist AI agents interacting with this repository Oct 16, 2025
@pedjak pedjak mentioned this pull request Oct 17, 2025
4 tasks
@@ -0,0 +1,251 @@
# AGENTS.md
Copy link
Contributor

@camilamacedo86 camilamacedo86 Oct 17, 2025

Choose a reason for hiding this comment

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

Hi @joelanford

Seems that Copilot accept AGENTS.md -> https://code.visualstudio.com/docs/copilot/customization/custom-instructions

But will that be understood by CLAUD and ANY other possible ones as well?

OH seems like they agreed upon: https://agents.md/

That is amazing !!!!

I researched that 2 months ago, and I could not find a generic/standard one. Things are changing too fast 🚀


This file provides instructions for autonomous agents working in the operator-controller repository.

## Repository Context
Copy link
Contributor

Choose a reason for hiding this comment

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

But before we add it, what info here is valid only for upstream?
If we add this, will all be valid for downstream? I do not think so,
So, how will we have information for upstream and another for downstream?

@joelanford @tmshort have you ideas?
What about we ignore those files in the sync/bumper?
Do we want to have the same for downstream? Could we have a version there that is not removed by the bumper as well?

@pedjak
Copy link
Contributor

pedjak commented Oct 20, 2025

I used Claude Code to generate the AGENTS.md file in this PR.

@joelanford out of curiosity, how did you instruct Cloude to generate this file?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants