Skip to content

CNTRLPLANE-4135: add AI contextification files - #71

Open
ehearne-redhat wants to merge 1 commit into
openshift:masterfrom
ehearne-redhat:ai-sdlc-context-files
Open

CNTRLPLANE-4135: add AI contextification files#71
ehearne-redhat wants to merge 1 commit into
openshift:masterfrom
ehearne-redhat:ai-sdlc-context-files

Conversation

@ehearne-redhat

Copy link
Copy Markdown

This PR adds AGENTS.md to give agents context on the repo from a glance, and also modifies README.md so that the purpose of the repo is clearer to newcomers. CLAUDE.md adds a symlink to AGENTS.md as Claude does not read AGENTS.md out of the box.

README.md adds examples of actual use, explains clearly the purpose of the repo, and dives into how to work with the project.

I don't think we need ARCHITECTURE.md or CONTRIBUTING.md as we have a common contributing guide (may need to link to it - reviewer, please let me know) and the architecture/layout of the repo isn't difficult to understand and the README/AGENTS file explain it enough.

I believe the main difficulty or challenger to a newcomer would be what exactly does the repo do, and I believe that is now explained clearly.

@openshift-ci-robot

openshift-ci-robot commented Aug 18, 2026

Copy link
Copy Markdown

@ehearne-redhat: This pull request references CNTRLPLANE-4135 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 "5.1.0" version, but no target version was set.

Details

In response to this:

This PR adds AGENTS.md to give agents context on the repo from a glance, and also modifies README.md so that the purpose of the repo is clearer to newcomers. CLAUDE.md adds a symlink to AGENTS.md as Claude does not read AGENTS.md out of the box.

README.md adds examples of actual use, explains clearly the purpose of the repo, and dives into how to work with the project.

I don't think we need ARCHITECTURE.md or CONTRIBUTING.md as we have a common contributing guide (may need to link to it - reviewer, please let me know) and the architecture/layout of the repo isn't difficult to understand and the README/AGENTS file explain it enough.

I believe the main difficulty or challenger to a newcomer would be what exactly does the repo do, and I believe that is now explained clearly.

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 openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 18, 2026
@ehearne-redhat

Copy link
Copy Markdown
Author

/jira-refresh

@openshift-ci
openshift-ci Bot requested review from deads2k and p0lyn0mial August 18, 2026 13:12
@openshift-ci

openshift-ci Bot commented Aug 18, 2026

Copy link
Copy Markdown

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

The full list of commands accepted by this bot can be found 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

@ehearne-redhat

Copy link
Copy Markdown
Author

I don't believe I have much control over the above failures. I can add the necessary bumps to get the checks to run.

Comment thread AGENTS.md Outdated
This commit adds AGENTS.md to give agents context on the repo from
a glance, and also modifies README.md so that the purpose of the
repo is clearer to newcomers. CLAUDE.md adds a symlink to AGENTS.md
as Claude does not read AGENTS.md out of the box.

README.md adds examples of actual use, explains clearly the purpose
of the repo, and dives into how to work with the project.
@openshift-ci

openshift-ci Bot commented Aug 20, 2026

Copy link
Copy Markdown

@ehearne-redhat: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/verify fa469ac link true /test verify
ci/prow/test-operator-integration fa469ac link true /test test-operator-integration
ci/prow/unit fa469ac link true /test unit

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.

@bhperry

bhperry commented Aug 20, 2026

Copy link
Copy Markdown

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Aug 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants