From 15d353a27daddb93cbbc61a611ba96b6ea1fbae1 Mon Sep 17 00:00:00 2001 From: Jakub Hadvig Date: Mon, 27 Apr 2026 15:21:09 +0200 Subject: [PATCH] NO-JIRA: Add Jira process documentation Add Definition of Ready and Definition of Verified documents under docs/process/ to serve as the source of truth for Jira issue readiness criteria and PR verification standards. These documents are consumed by Claude Code skills for automated bug triage and implementation. Co-Authored-By: Claude Opus 4.6 --- docs/process/README.md | 13 +++++ docs/process/definition-of-ready.md | 69 ++++++++++++++++++++++++++ docs/process/definition-of-verified.md | 20 ++++++++ 3 files changed, 102 insertions(+) create mode 100644 docs/process/README.md create mode 100644 docs/process/definition-of-ready.md create mode 100644 docs/process/definition-of-verified.md diff --git a/docs/process/README.md b/docs/process/README.md new file mode 100644 index 00000000000..286db976c64 --- /dev/null +++ b/docs/process/README.md @@ -0,0 +1,13 @@ +# Process + +This folder contains documents that define the OCP Console team's workflow standards. + +The Console team is responsible for maintaining two Jira projects: + +- **CONSOLE** — feature work (stories) +- **OCPBUGS** (Component: Management Console) — bug tracking + +## Documents + +- [Definition of Ready](definition-of-ready.md) — criteria a Jira issue (bug or story) must meet before the team picks it up for implementation. +- [Definition of Verified](definition-of-verified.md) — steps a reviewer must complete to verify a pull request, from readiness assessment through code review to functional verification. diff --git a/docs/process/definition-of-ready.md b/docs/process/definition-of-ready.md new file mode 100644 index 00000000000..1d83ca0ea19 --- /dev/null +++ b/docs/process/definition-of-ready.md @@ -0,0 +1,69 @@ +# Definition of Ready + +In order for the console team to pick up an issue (story or a bug), the following fields in Jira need to be set with appropriate inputs. It is the contributor's responsibility to provide the necessary input. A sufficient level of detail is required, since it will serve as input for AI tools which will be carrying out implementation of the task. + +In case an appropriate level of input is not available, the Console team reserves the right to pause the work on the issue. + +## Jira Bug + +Project: OCPBUGS + +All fields are mandatory unless explicitly marked as optional. + +* **Description:** + * Description of problem + * Version-Release + * Cluster type + * Cluster version + * Feature gate + * How reproducible + * Steps to Reproduce + * Actual results + * Expected result + * Additional info + * Configuration + 1. Browser (Chrome by default) + * Artifacts (at least one, linked in the description or in comments) + 1. Screenshot/recording + 2. Must-gather + 3. HAR file + 4. Console stack trace +* **Affects versions** +* **Fix Versions** +* **Target Backport Versions** (optional) +* **Target Version** +* **Severity** +* **Priority** (optional) +* **Component:** Management Console + +## Jira Story + +Project: CONSOLE + +All fields are mandatory unless explicitly marked as optional. + +* **Description:** + * Overall Objective + * User Stories (e.g., As a *kubeadmin*…, As a *developer* …) + * UX Designs (linked in the description or in comments) + * Test Cases + * Optional — in order to open the Jira Story + * Required — in order to call the Jira Story **Ready** + * Configuration + * Cluster type + * Feature gate +* **Priority** (optional) +* **Components** + +## Role Assignment + +Once a bug or story meets the criteria above and is declared ready, the OCP Console team will assign the following roles on the Jira issue: + +* **Assignee** + * Responsible for code changes + * Creates the Pull Request +* **QA Contact** + * Must be a different person than the Assignee + * Acts as the Pull Request assignee on GitHub + * Responsible for code review + * Responsible for functional verification diff --git a/docs/process/definition-of-verified.md b/docs/process/definition-of-verified.md new file mode 100644 index 00000000000..e5e9ddeaad1 --- /dev/null +++ b/docs/process/definition-of-verified.md @@ -0,0 +1,20 @@ +# Definition of Verified + +In order for the OCP Console team member to verify the Pull Request change, the steps below must be done serially: complete each step before starting the next. Do not treat them as parallel or interchangeable workstreams. + +## Pull Request Reviewer Responsibilities + +1. Readiness assessment + * Verify that the linked Jira issue meets the Definition of Ready before starting the review +2. Code review + * Assessing only code changes + * Focus area: + * Code changes + * Test coverage \- unit & e2e + 1. Adding new tests cases that cover the new functionality + 2. Update existing test cases if there is a functional change + * Provides `lgtm` label +3. Functional verification + * Manual testing of the change based on the provided Test Cases + * Automated CI testing is green + * Provides `verified` label