chore: improve jira ticketrule #5895
Conversation
|
caseyisonit
added
Component: Tooling
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
nikkimk
left a comment
nikkimk
left a comment
There was a problem hiding this comment.
Thank you for taking this on. As with all @caseyisonit this will improve our DX/quality of life significantly. ❤️ ❤️ ❤️
Left two nits and one a11y-related change in the comments.
|
|
||
| **Essential formatting:** | ||
|
|
||
| - `h2.` for section headings (avoid `h1.` in descriptions) |
There was a problem hiding this comment.
nit: Can we have headings 4 and 5 too?
| Use this guide to determine the appropriate severity level: | ||
|
|
||
| **SEV1 (Critical)** - Immediate action required: | ||
|
|
||
| - Production system is down | ||
| - Data loss or corruption | ||
| - Security vulnerability or breach | ||
| - Complete feature failure affecting all users | ||
|
|
||
| **SEV2 (High)** - Action required within 24-48 hours: | ||
|
|
||
| - Major feature is broken for most users | ||
| - Significant performance degradation | ||
| - Workaround exists but is impractical | ||
| - Blocking progress on dependent work | ||
|
|
||
| **SEV3 (Medium)** - Action required within 1-2 weeks: | ||
|
|
||
| - Feature partially broken or unreliable | ||
| - Affects subset of users | ||
| - Reasonable workaround available | ||
| - Non-critical functionality impaired | ||
|
|
||
| **SEV4 (Low)** - Action required within a month: | ||
|
|
||
| - Minor bugs with minimal impact | ||
| - Edge case issues | ||
| - Nice-to-have improvements | ||
| - Non-blocking technical debt | ||
|
|
||
| **SEV5 (Trivial)** - No urgency: | ||
|
|
||
| - Cosmetic issues only | ||
| - Documentation typos | ||
| - Code formatting | ||
| - Optional optimizations |
There was a problem hiding this comment.
Can we add bullets about accessibility issues for each of the severity levels?
There was a problem hiding this comment.
would you mind suggesting the language you would want to use for each level?
| - Attach screenshots or videos for visual changes | ||
| - Reference design specs or documentation when available | ||
| - Link to GitHub using plain text format: `GitHub Issue #123` or full URLs | ||
| - Include component name in brackets: `[sp-button]` |
There was a problem hiding this comment.
nit: Should we use JIRA syntax {{sp-button}}?
There was a problem hiding this comment.
we use brackets in our ticket titles so i'll likely keep this syntax
Description
This improves the cursor rule for assisting with writing jira tickets. It includes better formatting instructions, examples and dos/donts
Motivation and context
Less buggy formatting output, better aligned with our expectations for a good ticket
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Draft a jira ticket