Skip to content

HYPERFLEET-1092 - docs: add ticket hygiene standard#142

Open
rafabene wants to merge 3 commits into
openshift-hyperfleet:mainfrom
rafabene:HYPERFLEET-1092-ticket-hygiene-standard
Open

HYPERFLEET-1092 - docs: add ticket hygiene standard#142
rafabene wants to merge 3 commits into
openshift-hyperfleet:mainfrom
rafabene:HYPERFLEET-1092-ticket-hygiene-standard

Conversation

@rafabene
Copy link
Copy Markdown
Contributor

@rafabene rafabene commented May 21, 2026

Summary

  • Adds hyperfleet/standards/ticket-hygiene.md — prescriptive standard defining JIRA field requirements per issue type (Story, Task, Bug, Epic), valid components, activity types with tier-based decision flow, story points scale, and sprint readiness criteria
  • Updates hyperfleet/docs/working-agreement.md Definition of Ready to cross-reference the new standard
  • Updates hyperfleet/standards/CLAUDE.md standards table to include the new document
  • Updates README.md engineering standards table with new "Process" category

Test plan

  • Verify all internal links resolve (TOC anchors, cross-file references)
  • Verify components list matches current JIRA project configuration
  • Verify activity types match current JIRA custom field options
  • Run /jira-triage against a sample sprint to confirm the standard aligns with existing plugin behavior
  • Verify README.md standards table renders correctly on GitHub

@openshift-ci openshift-ci Bot requested review from Mischulee and pnguyen44 May 21, 2026 14:36
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 21, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jsell-rh for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 1f688a23-c434-42f5-a2e2-19ae02720405

📥 Commits

Reviewing files that changed from the base of the PR and between 574cc4d and e6503d8.

📒 Files selected for processing (1)
  • hyperfleet/standards/ticket-hygiene.md

📝 Walkthrough

Summary by CodeRabbit

Release Notes

  • Documentation
    • Introduced new "Ticket Hygiene" engineering standard defining JIRA field requirements and sprint entry readiness criteria.
    • Updated working agreement to require completeness of JIRA fields as part of definition of ready.
    • Added comprehensive ticket hygiene guidance covering issue-type requirements, component values, activity type taxonomy, story point estimation rules, and automated sprint validation.

Walkthrough

This PR introduces the HyperFleet Ticket Hygiene Standard and integrates it into repository docs. It adds a new standards document defining required vs recommended JIRA fields, per-issue-type completeness rules, valid Component values with repository mappings, an Activity Type taxonomy and decision flow, a modified Fibonacci Story Points scale with sizing/splitting rules, Fix Version guidance, worked examples, and enforcement via hyperfleet-jira commands and a sprint-planning gate. The README, working-agreement, and standards registry were updated to reference the new standard.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a new ticket hygiene standard document to the HyperFleet repository.
Description check ✅ Passed The description is directly related to the changeset, providing a clear summary of what was added and modified, plus a comprehensive test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@rafabene rafabene force-pushed the HYPERFLEET-1092-ticket-hygiene-standard branch from 9542a7d to e2372a3 Compare May 21, 2026 14:51
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@hyperfleet/standards/ticket-hygiene.md`:
- Line 122: Replace the non-RFC2119 phrase "Activity Type is **required**" with
the RFC 2119 keyword form (e.g., "Activity Type MUST be provided") so the
standard uses prescriptive language; update the sentence that explains tickets
without an Activity Type appear as "Uncategorized" in Sankey capacity reports to
read something like "Activity Type MUST be set; tickets without an Activity Type
are shown as 'Uncategorized' in the Sankey capacity reports," ensuring the term
"Activity Type" and the behavior for "Uncategorized" remain unchanged.
- Line 178: Replace the informal phrasing "8-point tickets require a design doc"
with an RFC 2119 compliant term to match the rest of the standard; update the
sentence to read something like "8-point tickets MUST include a design doc" (or
"MUST have a design doc") so it uses the RFC2119 keyword and is consistent with
other entries in the document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: e3f7b9f9-da02-437c-830a-29e7dda0d303

📥 Commits

Reviewing files that changed from the base of the PR and between 9542a7d and e2372a3.

📒 Files selected for processing (4)
  • README.md
  • hyperfleet/docs/working-agreement.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/standards/ticket-hygiene.md

Comment thread hyperfleet/standards/ticket-hygiene.md Outdated
Comment thread hyperfleet/standards/ticket-hygiene.md Outdated
@rafabene rafabene force-pushed the HYPERFLEET-1092-ticket-hygiene-standard branch from e2372a3 to 31de385 Compare May 21, 2026 14:57
@rafabene
Copy link
Copy Markdown
Contributor Author

Both CodeRabbit findings addressed:

  • Line 122: Changed Activity Type is **required**Activity Type MUST be set
  • Line 178: Changed 8-point tickets require a design doc8-point tickets MUST have a design doc

Both now use RFC 2119 keywords consistently with the rest of the standard.

@rafabene rafabene force-pushed the HYPERFLEET-1092-ticket-hygiene-standard branch from 31de385 to 0a3c09d Compare May 21, 2026 14:58
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@hyperfleet/standards/ticket-hygiene.md`:
- Line 32: Add an explicit precedence rule that resolves the conflict between
the global "Required Fields" baseline and the per-type Epic matrix: state that
the baseline "Required Fields" applies as the sprint-entry minimum for
Story/Task/Bug, while the per-issue-type field matrix (the Epic matrix in the
per-type table) overrides the baseline for Epics (i.e., Epic fields follow
MUST/SHOULD/MAY defined in the matrix); update the "Required Fields" section and
the Epic-related per-type table entries referenced around the existing Epic
matrix so triage tools and humans apply the per-type rules for Epics and the
global baseline for other types.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 8dac0d44-9774-4acd-b567-def437279c4f

📥 Commits

Reviewing files that changed from the base of the PR and between e2372a3 and 0a3c09d.

📒 Files selected for processing (4)
  • README.md
  • hyperfleet/docs/working-agreement.md
  • hyperfleet/standards/CLAUDE.md
  • hyperfleet/standards/ticket-hygiene.md

Comment thread hyperfleet/standards/ticket-hygiene.md Outdated
Codifies JIRA field requirements per issue type, valid components,
activity types, story points scale, and sprint readiness criteria
as a prescriptive standard. Cross-references from working agreement
Definition of Ready and main README engineering standards table.
@rafabene rafabene force-pushed the HYPERFLEET-1092-ticket-hygiene-standard branch from 0a3c09d to 574cc4d Compare May 21, 2026 15:02
Comment thread hyperfleet/standards/ticket-hygiene.md Outdated
Comment thread hyperfleet/standards/ticket-hygiene.md Outdated
rafabene and others added 2 commits May 21, 2026 17:54
Co-authored-by: Leonardo Dorneles <149205964+ldornele@users.noreply.github.com>
Co-authored-by: Leonardo Dorneles <149205964+ldornele@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants