Skip to content

OPRUN-4268: Add AGENTS.md to allow agents to make contributions to the codebase - #580

Merged
openshift-merge-bot[bot] merged 4 commits into
openshift:mainfrom
rashmigottipati:add-agents-file
Dec 11, 2025
Merged

OPRUN-4268: Add AGENTS.md to allow agents to make contributions to the codebase#580
openshift-merge-bot[bot] merged 4 commits into
openshift:mainfrom
rashmigottipati:add-agents-file

Conversation

@rashmigottipati

@rashmigottipatirashmigottipati commented Dec 11, 2025

Copy link
Copy Markdown
Member

Fixes: OPRUN-4268

Signed-off-by: Rashmi Gottipati <rgottipa@redhat.com>
Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated

@ankitathomasankitathomas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
Comment threadopenshift/AGENTS.md Outdated
1. **Understand the intent:** Is this fixing an OpenShift-specific issue or an upstream bug?

2. **Choose the right approach:**
- If it's an upstream bug → Should be fixed in `operator-framework/operator-controller` first, then cherry-picked

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not cherry-picked. The downstream-related tooling should be allowed to execute, replaying commits against our fork of the upstream branch, once that has been fast-forwarded.

Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated

1. **The fix should ideally go to upstream `operator-framework/operator-controller` first**
2. **Then cherry-pick** to OpenShift using `UPSTREAM: <PR number>:` format
3. **Only use `UPSTREAM: <carry>:`** for truly OpenShift-specific behavior

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
3.**Only use `UPSTREAM: <carry>:`** for truly OpenShift-specific behavior
3.**Only use `UPSTREAM: <carry>:`** for truly OpenShift-specific behavior for content which is not generated

Comment threadopenshift/AGENTS.md Outdated
Comment threadopenshift/AGENTS.md Outdated
| OpenShift integration | `UPSTREAM: <carry>:` | ❌ NO - Downstream only |
| OpenShift config | `UPSTREAM: <carry>:` | ❌ NO - Downstream only |
| Remove upstream file | `UPSTREAM: <drop>:` | ❌ NO - Downstream only |
| Generated files | `UPSTREAM: <drop>:` | ❌ NO - Regenerate with `make manifests` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This contradicts previous guidance here which implies that generated stuff which we need to temporarily resolve until some later PR should use this process.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

But it is something we do, and something I have done.

@grokspawn

Copy link
Copy Markdown
Contributor

There's some duplicated and internally contradictory content here. Could you re-run this through claude with a "be concise and consistent" prompt modification? If you also direct it to resolve PR comments then you should be able to get to a happy update in a single step.

Signed-off-by: Rashmi Gottipati <rgottipa@redhat.com>
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
Comment threadopenshift/AGENTS.md Outdated
@tmshort

tmshort commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

TL;DR: we don't cherry-pick to the main branch. We allow the bumper (in openshift/operator-framework-tooling) synchronize from upstream.

However, cherry-picking would be done on release branches, but since most downstream work is on the main branch, cherry-picking is uncommon.

We would almost never see UPSTREAM: pr-number commits. because they would create a conflict on the next upstream sync. Instead, we might do an UPSTREAM: <drop> commit to pull down a fix early, as it then gets dropped on the next sync.

UPSTREAM: <carry> is used for most changes, and 99% of the time, those changes ought to be limited to the openshift directory. Code outside of the openshift directory should generally not be modified downstream; it should be modified upstream and then synced downstream.

UPSTREAM: <drop> is for temporary commits (e.g. the upstream PR example) that are to be dropped on the next sync. They are used by the bumper to create commits that are easier to recreate than to rebase/cherry-pick. For example: UPSTREAM: <drop>: remove upstream GitHub configuration

EDIT: You updated the file as I was writing this... so looking 👀 again.

Comment threadopenshift/AGENTS.md Outdated

@ankitathomasankitathomas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
@tmshort

Copy link
Copy Markdown
Contributor

This version is much better. I think I had just one comment on the frequency of the synchronization.

Signed-off-by: Rashmi Gottipati <rgottipa@redhat.com>
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
@tmshort

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
Comment threadopenshift/AGENTS.md Outdated
Signed-off-by: Rashmi Gottipati <rgottipa@redhat.com>
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2025
@tmshort

Copy link
Copy Markdown
Contributor

/lgtm

@tmshort

Copy link
Copy Markdown
Contributor

/approve

@openshift-ciopenshift-ciBot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Dec 11, 2025
@openshift-ci

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ankitathomas, grokspawn, rashmigottipati, tmshort

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

@tmshort

Copy link
Copy Markdown
Contributor

/label acknowledge-critical-fixes-only

@openshift-ciopenshift-ciBot added the acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. label Dec 11, 2025
@tmshort

Copy link
Copy Markdown
Contributor

/retitle NO-ISSUE: Add AGENTS.md to allow agents to make contributions to the codebase

@openshift-ciopenshift-ciBot changed the title Add AGENTS.md to allow agents to make contributions to the codebaseNO-ISSUE: Add AGENTS.md to allow agents to make contributions to the codebaseDec 11, 2025
@openshift-ci-robotopenshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 11, 2025
@openshift-ci-robot

Copy link
Copy Markdown

@rashmigottipati: This pull request explicitly references no jira issue.

Details

In response to this:

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 openshift-eng/jira-lifecycle-plugin repository.

@rashmigottipatirashmigottipati changed the title NO-ISSUE: Add AGENTS.md to allow agents to make contributions to the codebaseOPRUN-4268: Add AGENTS.md to allow agents to make contributions to the codebaseDec 11, 2025
@openshift-ci-robot

openshift-ci-robot commented Dec 11, 2025

Copy link
Copy Markdown

@rashmigottipati: This pull request references OPRUN-4268 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.21.0" version, but no target version was set.

Details

In response to this:

Fixes: OPRUN-4268

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 openshift-eng/jira-lifecycle-plugin repository.

@rashmigottipati

Copy link
Copy Markdown
MemberAuthor

/refresh

@bandrade

Copy link
Copy Markdown
Contributor

/label qe-approved
/verified by @bandrade

@openshift-ciopenshift-ciBot added the qe-approved Signifies that QE has signed off on this PR label Dec 11, 2025
@openshift-ci-robotopenshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Dec 11, 2025
@openshift-ci-robot

openshift-ci-robot commented Dec 11, 2025

Copy link
Copy Markdown

@rashmigottipati: This pull request references OPRUN-4268 which is a valid jira issue.

Details

In response to this:

Fixes: OPRUN-4268

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot

Copy link
Copy Markdown

@bandrade: This PR has been marked as verified by @bandrade.

Details

In response to this:

/label qe-approved
/verified by @bandrade

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci

Copy link
Copy Markdown
Contributor

@rashmigottipati: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@openshift-merge-bot
openshift-merge-botBot merged commit 47053e9 into openshift:mainDec 11, 2025
11 checks passed
@rashmigottipati
rashmigottipati deleted the add-agents-file branch December 11, 2025 22:28
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

acknowledge-critical-fixes-onlyIndicates if the issuer of the label is OK with the policy.approvedIndicates a PR has been approved by an approver from all required OWNERS files.jira/valid-referenceIndicates that this PR references a valid Jira ticket of any type.lgtmIndicates that a PR is ready to be merged.qe-approvedSignifies that QE has signed off on this PRverifiedSignifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@rashmigottipati@grokspawn@tmshort@openshift-ci-robot@bandrade@joelanford@ankitathomas