-
Notifications
You must be signed in to change notification settings - Fork 73
OCPQE-30995: Define AI Guide for OLMv0 QE Migration cases #1128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
@kuiwang02: This pull request references OCPQE-30995 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 sub-task to target the "4.21.0" version, but no target version was set. 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. |
@kuiwang02: This pull request references OCPQE-30995 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 sub-task to target the "4.21.0" version, but no target version was set. 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. |
/cc @bandrade |
/approve |
/verified by @kuiwang02 |
@kuiwang02: This PR has been marked as verified by 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. |
/verified by @kuiwang02 |
@kuiwang02: This PR has been marked as verified by 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. |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jianzhangbjz, kuiwang02 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
1. **Start Claude Code from tests-extension directory**: | ||
```bash | ||
cd tests-extension/ | ||
# Then launch Claude Code from this directory |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's better to add the specific Command here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no specfic command. just claude
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated. thanks
tests-extension/test/qe/README.md
Outdated
# Then launch Claude Code from this directory | ||
``` | ||
2. **Load AGENTS.md**: When prompted by Claude Code to load the AGENTS.md file, select **Yes** to enable comprehensive context about the OLM v0 QE test framework. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no. it is agent.md, not agent. it is diffrent thing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated. thanks
/verified by @kuiwang02 |
@kuiwang02: This PR has been marked as verified by 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. |
/lgtm |
/retest-required |
@kuiwang02: The following test failed, say
Full PR test history. Your PR dashboard. 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. |
Add Comprehensive AGENTS.md Guide for OLM v0 QE Test Extension Migration
Why / Problem Statement
The OLM v0 QE Test Extension project (
tests-extension/
) is a specialized testing framework for validating OLM v0 functionality in OpenShift clusters. As the project grows with migrated test cases fromopenshift-tests-private
and new test development, there is a critical need for:AI Agent Guidance: AI coding assistants (like Claude Code) need comprehensive context about:
Developer Onboarding: New QE engineers and contributors need clear documentation covering:
Consistency: Without documented standards, test cases may be written inconsistently, leading to:
This PR addresses these needs by providing a single, authoritative guide that serves both AI agents and human developers.
What / Solution
Added comprehensive documentation to guide AI agents and developers working with the OLM v0 QE Test Extension:
Changes Made
tests-extension/AGENTS.md:1-1179
- Comprehensive AI agent guide covering:tests-extension/CLAUDE.md:1
- Pointer file directing to AGENTS.md for Claude Code integrationKey Technical Decisions
AGENTS.md Format: Chose comprehensive markdown over separate docs because:
Context Awareness Section: Added explicit rules for when to apply this guidance (lines 26-73) to prevent:
Suite Definition Details: Included exact qualifier expressions (lines 130-280) because:
cmd/main.go
may change over timeMigration Guide Completeness: Documented ALL code changes needed from tests-private migration:
exutil.By()
→g.By()
)olmv0util.
prefix)exutil.
prefix)Anti-Patterns Section: Explicitly called out problematic patterns with examples:
o.Expect
inwait.Poll
loopsg.Describe
blocksTest Structure Patterns: Provided three separate patterns for:
Testing
This documentation has been validated through:
cmd/main.go:1-319
test/qe/specs/*.go
tests-extension/
Additional Context
Why AGENTS.md Now?
This documentation is being added at a critical juncture:
Documentation Philosophy
This AGENTS.md follows emerging best practices for AI-era codebases:
Relationship to Other Documentation
Future Enhancements
While this PR provides comprehensive documentation, future additions may include:
cmd/main.go
Note: This documentation is specifically for the
tests-extension/
directory and should NOT be applied when working with product code in other parts of theoperator-framework-olm
repository.Assisted-by: Claude Code
/cc @jianzhangbjz @Xia-Zhao-rh @bandrade