CNTRLPLANE-4135: add AI contextification files - #71
Conversation
|
@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. DetailsIn 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. |
|
/jira-refresh |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
I don't believe I have much control over the above failures. I can add the necessary bumps to get the checks to run. |
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.
729f7aa to
fa469ac
Compare
|
@ehearne-redhat: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
/lgtm |
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.mdorCONTRIBUTING.mdas 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.