chore: cursor utilities [CSS-1222]
Description
Added structured rules configuration for Cursor to enforce consistent formatting in documentation and Jira tickets. This includes:
- JSON configuration for enforcing text formatting rules
- Standardized templates for Jira tickets
- Automated validation of ticket structure and labels
- Documentation for rule usage and maintenance
Motivation and context
This change provides automated enforcement of our documentation standards and Jira ticket formatting, ensuring consistency across the project. It helps team members create well-structured tickets and maintain consistent documentation formatting without manual oversight.
Related issue(s)
- fixes CSS-1222
Author's checklist
- [x] I have read the CONTRIBUTING and PULL_REQUESTS documents.
- [x] I have included updated documentation in the form of README.md and rules.json.
Reviewer's checklist
- [x] Includes a Github Issue with appropriate flag or Jira ticket number without a link
- [ ] Includes thoughtfully written changeset if changes suggested include
patch,minor, ormajorfeatures - [ ] Automated tests cover all use cases and follow best practices for writing
- [ ] Validated on all supported browsers
- [ ] All VRTs are approved before the author can update Golden Hash
Manual review test cases
-
[x] Verify Jira ticket formatting rules
- Create a new Jira ticket
- Attempt to use title case in headings
- Verify Cursor enforces sentence case with appropriate exceptions
-
[ ] Verify template enforcement
- Create a new bug report
- Skip required fields
- Verify Cursor requires all mandatory sections
-
[ ] Verify label validation
- Add a non-standard label to a ticket
- Verify Cursor flags invalid labels
- Confirm allowed labels are accepted
⚠️ No Changeset found
Latest commit: 867cb3457ed4aa8d097abdc3b737509e4d29c9fe
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Branch preview
Review the following VRT differences
When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
- Spectrum | Light | Medium | LTR
- Spectrum | Dark | Large | RTL
- Express | Light | Medium | LTR
- Express | Dark | Large | RTL
- Spectrum-two | Light | Medium | LTR
- Spectrum-two | Dark | Large | RTL
- High Contrast Mode | Medium | LTR
If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.
Tachometer results
Currently, no packages are changed by this PR...
I am experiencing some confusion. Currently, Jira tickets are created by us- so will cursor create the jira tickets after merging this??
I am experiencing some confusion. Currently, Jira tickets are created by us- so will cursor create the jira tickets after merging this??
@blunteshwar No, there's no access tokens for our Jira instance at this time so it can't make them but it can output the template for you via a prompt. For example, I've attached this instruction guide and described what I'd like to create a ticket for in plain language and it's stubbed out the information appropriately using the template. Then, after some clean-up, I can copy and paste that content into Jira.
📚 Branch Preview
🔍 Visual Regression Test Results
When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
- Spectrum | Light | Medium | LTR
- Spectrum | Dark | Large | RTL
- Express | Light | Medium | LTR
- Express | Dark | Large | RTL
- Spectrum-two | Light | Medium | LTR
- Spectrum-two | Dark | Large | RTL
- High Contrast Mode | Medium | LTR
Deployed to Azure Blob Storage: pr-5505
If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.