chore: improve cursor prompts #4028
Conversation
|
castastrophe
force-pushed
the
castastrophe/chore-cursor-utilities-css-222
branch
from
4ff40e7 to
9acc449
Compare
castastrophe
added
skip_vrt
File metricsSummaryTotal size: 1.43 MB* 🎉 No changes detected in any packages * Size is the sum of all main files for packages in the library.* An ASCII character in UTF-8 is 8 bits or 1 byte. |
📚 Branch previewPR #4028 has been deployed to Azure Blob Storage: https://spectrumcss.z13.web.core.windows.net/pr-4028/index.html. |
castastrophe
force-pushed
the
castastrophe/chore-cursor-utilities-css-222
branch
from
9acc449 to
61f9257
Compare
| 1. Cursor will automatically enforce these rules while editing relevant files; however, if you wish to enable a rule that is not triggered by default, you can do so by `@` mentioning it in the chat. | ||
| 2. Rules can be toggled using the `enabled` flag | ||
| 3. Custom error messages will be shown when rules are violated | ||
| 4. Exceptions are handled through the `exceptions` field in relevant rules |
There was a problem hiding this comment.
Super nitpicky- the bullet points have mixed punctuation right now, with one being punctuated, and then the others not being punctuated. How do you feel about adding punctuation to all of them? Or would you rather have them all without punctuation?
|
|
||
| ### Jira tickets | ||
|
|
||
| - **ticket_title**: Validates Jira ticket title format |
There was a problem hiding this comment.
This probably should correspond to title_format in the mdc file.
| 2. Auto-fix results based on settings defined by the `../../stylelint.config.js` unless it requires rewriting more than 30% of the line. Changes that impact more than 30% of the original content should prompt for update. | ||
| 3. Copyrights should reflect the current year. | ||
| 4. Comments added should always use sentence, never title case. | ||
| 5. Any files removed should also be removed from the exports of the component's package.json. |
There was a problem hiding this comment.
Take it or leave it:
| 5. Any files removed should also be removed from the exports of the component's package.json. | |
| 5. Any files removed should also be removed from the exports of the component's `package.json`. |
| alwaysApply: true | ||
| --- | ||
|
|
||
| 1. Follow rules outlined in the `../../STYLING.md` file. |
There was a problem hiding this comment.
Do we have a STYLING.md file? Am I missing it somewhere? Is a guide in the storybook directory? 👀
There was a problem hiding this comment.
Oh haha no! I think that's actually an SWC thing. I should find a CSS-comparable document.
Description
Added structured rules configuration for Cursor to enforce consistent formatting in documentation and Jira tickets. This includes:
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)
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Verify Jira ticket formatting rules
Verify template enforcement
Verify label validation