Add AGENTS.md and contributor skill playbooks - #882
Open
Vincent056 wants to merge 1 commit into
Open
Conversation
AGENTS.md documents the project layout, controller patterns, AIDE configuration quirks, Dockerfile topology, kubebuilder markers, test styles, and file-size guidance for the repo. Mirrors the top-level conventions doc pattern used by other agent-assisted projects (e.g. openai/codex). Three focused skill playbooks under .claude/skills/ cover the recurring FIO workflows an agent is likely to drive: - prow-logs: fetch OpenShift Prow CI artifacts (build logs, JUnit, gather-extra) for a failing presubmit job. - e2e-triage: how the operator is deployed during make e2e, five paths to validate a feature branch, live-state inspection commands, result-ConfigMap decode, and known failure shapes. - release-fio: the two-PR backport-plus-release dance for a z-stream (1.3.X), and the .tekton / Konflux setup for a new y-stream release branch (1.4.0). Documentation-only; no runtime code changes.
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Vincent056 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
approved
Contributor
|
@Vincent056: all tests passed! 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdat repo root as a top-level conventions document. Covers project layout, controller patterns, kubebuilder markers, AIDE config quirks, the four Dockerfiles, test styles, and file-size guidance..claude/skills/for recurring FIO workflows:prow-logs— fetch OpenShift Prow CI artifacts (build logs, JUnit, gather-extra) for a failing presubmit job.e2e-triage— explain how the operator is deployed duringmake e2e, five paths to validate a feature branch, live-state inspection commands, result-ConfigMap decode, and known failure shapes.release-fio— the two-PR backport-plus-release dance for a z-stream (1.3.X), and the.tekton/ Konflux setup for a new y-stream release branch (1.4.0).Why
Contributors (human and agentic) recurrently ask the same questions about this repo: how is the operator deployed during e2e, what breaks on a release, where do the Prow logs live, which Dockerfile is which, what's the PR title convention. This change captures the answers in one place so future contributors can skip the archaeology.
Documentation-only; no runtime code changes. The
pkg/andcmd/trees are untouched.Test plan
make test-unitpasses (no code changes).make verifypasses (no code changes).AGENTS.mdfor any remaining references that should be removed.SKILL.mdfor any project-specific errata.