Skip to content

chore: add AGENTS.md with E2E test rules - #1296

Open
jgwest wants to merge 1 commit into
redhat-developer:masterfrom
jgwest:add-agents-md-sept-2026
Open

jgwest wants to merge 1 commit into
redhat-developer:masterfrom
jgwest:add-agents-md-sept-2026

Conversation

@jgwest

@jgwest jgwest commented Sep 15, 2026

Copy link
Copy Markdown
Member

What type of PR is this?
/kind code-refactoring

What does this PR do / why we need it:

  • This PR adds an AGENTS.md (plus symlinks for cursor/claude)
  • AGENTS.md contain some simple rules for folks contributing E2E tests. See file for details.

Have you updated the necessary documentation?

  • Documentation update is required by this PR.
  • Documentation has been updated.

Test acceptance criteria:

  • Unit Test
  • E2E Test

How to test changes / Special notes to the reviewer:

Signed-off-by: Jonathan West <jgwest@gmail.com>
@openshift-ci

openshift-ci Bot commented Sep 15, 2026

Copy link
Copy Markdown

@jgwest: The label(s) kind/code-refactoring cannot be applied, because the repository doesn't have them.

Details

In response to this:

What type of PR is this?
/kind code-refactoring

What does this PR do / why we need it:

  • This PR adds an AGENTS.md (plus symlinks for cursor/claude)
  • AGENTS.md contain some simple rules for folks contributing E2E tests. See file for detgails.

Have you updated the necessary documentation?

  • Documentation update is required by this PR.
  • Documentation has been updated.

Test acceptance criteria:

  • Unit Test
  • E2E Test

How to test changes / Special notes to the reviewer:

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.

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 0a1733f4-6e9b-4f87-b643-60f02902eb7d

📥 Commits

Reviewing files that changed from the base of the PR and between ae98868 and bcbbeed.

📒 Files selected for processing (3)
  • .cursorrules
  • AGENTS.md
  • CLAUDE.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • argoproj-labs/argocd-operator (manual)

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added repository guidance for writing OpenShift Ginkgo end-to-end tests.
    • Documented fixture-specific update helpers and required setup for parallel and sequential tests.
    • Consolidated guidance through shared documentation references.

Walkthrough

The pull request adds shared repository guidance for OpenShift Ginkgo E2E tests. It also adds symbolic links from .cursorrules and CLAUDE.md to AGENTS.md.

Changes

Repository guidance

Layer / File(s) Summary
Guidance and tool links
AGENTS.md, .cursorrules, CLAUDE.md
AGENTS.md documents fixture-specific update helpers, parallel and sequential Describe blocks, and matching clean-slate setup calls. .cursorrules and CLAUDE.md link to AGENTS.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to bcbbe

The repository guidance and tool links are consistent, so this change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the main change: adding AGENTS.md with E2E test rules. It also matches the added Cursor and Claude symlinks at a concise level.
Description check ✅ Passed The description explains that the PR adds AGENTS.md and symlinks for Cursor and Claude, and it identifies the E2E test contribution rules.

Comment @coderabbitai help to get the list of available commands.

@olivergondza

Copy link
Copy Markdown
Collaborator

/lgtm
/approve

@openshift-ci

openshift-ci Bot commented Sep 16, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: olivergondza

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

@jgwest

jgwest commented Sep 16, 2026

Copy link
Copy Markdown
Member Author

InternetGatewayLimitExceeded: The maximum number of internet gateways has been reached.

/retest

@openshift-ci

openshift-ci Bot commented Sep 16, 2026

Copy link
Copy Markdown

@jgwest: 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/v4.19-kuttl-sequential bcbbeed link true /test v4.19-kuttl-sequential
ci/prow/v4.14-kuttl-parallel bcbbeed link false /test v4.14-kuttl-parallel

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.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants