-
Notifications
You must be signed in to change notification settings - Fork 700
NO-JIRA: Add Jira process documentation for Definition of Ready and Verified #16352
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
Open
jhadvig
wants to merge
1
commit into
openshift:main
Choose a base branch
from
jhadvig:team-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
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.
Uh oh!
There was an error while loading. Please reload this page.