HYPERFLEET-1092 - docs: add ticket hygiene standard#142
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbitRelease Notes
WalkthroughThis 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)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
9542a7d to
e2372a3
Compare
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
README.mdhyperfleet/docs/working-agreement.mdhyperfleet/standards/CLAUDE.mdhyperfleet/standards/ticket-hygiene.md
e2372a3 to
31de385
Compare
|
Both CodeRabbit findings addressed:
Both now use RFC 2119 keywords consistently with the rest of the standard. |
31de385 to
0a3c09d
Compare
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
README.mdhyperfleet/docs/working-agreement.mdhyperfleet/standards/CLAUDE.mdhyperfleet/standards/ticket-hygiene.md
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.
0a3c09d to
574cc4d
Compare
Co-authored-by: Leonardo Dorneles <149205964+ldornele@users.noreply.github.com>
Co-authored-by: Leonardo Dorneles <149205964+ldornele@users.noreply.github.com>
Summary
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 criteriahyperfleet/docs/working-agreement.mdDefinition of Ready to cross-reference the new standardhyperfleet/standards/CLAUDE.mdstandards table to include the new documentREADME.mdengineering standards table with new "Process" categoryTest plan
/jira-triageagainst a sample sprint to confirm the standard aligns with existing plugin behaviorREADME.mdstandards table renders correctly on GitHub