-
Couldn't load subscription status.
- Fork 1.3k
chore: add cursor rule for release notes #9033
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+85
−0
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| description: Use when formatting commit messages for release notes | ||
| globs: | ||
| alwaysApply: false | ||
| --- | ||
|
|
||
| Given a list of commit messages, follow the steps to process them. | ||
|
|
||
| ## Step 1: Categorize Commits | ||
|
|
||
| Sort ALL commit messages into one of six main categories. The main categories are the following: | ||
| - Enhancements | ||
| - Fixes | ||
| - Documentation | ||
| - Under Construction | ||
| - To Be Categorized | ||
| - S2 | ||
|
|
||
| ### Categorization Rules: | ||
| Use the following keywords to determine the category: | ||
| | Keyword | Category | | ||
| |----------------------------|----------| | ||
| | feat | Enhancements| | ||
| | fix | Fixes | | ||
| | docs | Documentation | | ||
| | alpha, beta, rc | Under Construction | ||
| | chore, revert, bump, build | To Be Categorized | | ||
| | S2 | S2 | | ||
|
|
||
| Each category name must be written as a Markdown H2 heading using ##. | ||
|
|
||
| ## Step 2: Rewrite commit messages | ||
|
|
||
| Original format: Type (Scope): Summary of changes - [@username](link to username) - [PR](link to PR) | ||
| New Format: Summary of changes - [@username](link to username) - [PR](link to PR) | ||
snowystinger marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### General Guidelines: | ||
| - Keep the summary as a single, grammatically correct sentence | ||
| - The message should be concise and easy to read | ||
| - Wrap any camelCase or code-like terms (e.g. onClick, onAction, isDisabled) in backticks (`) | ||
| - Do NOT use backticks for component names | ||
| - Replace specific terms: | ||
| - RAC -> React Aria | ||
| - V3 -> React Spectrum | ||
| - ALWAYS capitalize UI component names | ||
| - Example: | ||
| - toast -> Toast | ||
| - inline alert -> InlineAlert | ||
|
|
||
| ### Component Names to Capitalize: | ||
| Accordion, Autocomplete, Badge, Breadcrumbs, Buttons, Calendar, Checkbox, CheckboxGroup, Collections, ColorArea, ColorField, ColorPicker, ColorSlider, ColorSwatch, ColorSwatchPicker, ColorWheel, ComboBox, Date and Time, DateField, DatePicker, DateRangePicker, Dialog, Disclosure, DisclosureGroup, Drag and Drop, DropZone, FileTrigger, Form, InlineAlert, Link, Listbox, ListView, Menu, Meter, Modal, NotificationBadge, NumberField, Picker, ProgressBar, ProgressCircle, RadioGroup, RangeCalendar, SearchField, Select, Slider, StatusLight, Switch, Table, Tabs, TagGroup, TextArea, TextField, TimeField, Toast, ToggleButton, ToggleButtonGroup, Tooltip, Tree, Virtualizer. | ||
|
|
||
|
|
||
| ## Step 3: Add Sub-headings | ||
|
|
||
| Within the Enhancements, Fixes, and Under Construction categories, group commits by UI component under sub-headings. | ||
|
|
||
| ### Sub-heading rules: | ||
| - Use sub-headings ONLY for: | ||
| - Enhancements | ||
| - Fixes | ||
| - Under Construction | ||
| - Do NOT create sub-headings for: | ||
| - Documentation | ||
| - To Be Categorized | ||
| - S2 | ||
| - Sub-headings should be in alphabetical order | ||
| - Use "Miscellaneous" as a sub-heading for commits that do not belong to a specific component | ||
| - Each category can have its own Miscellaneous sub-heading | ||
| - Write sub-headings and commits as unordered lists using a hyphen (-) | ||
| - Do NOT bold the sub-heading text | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when I ran this locally, it classified the autocomplete changes as enhancements but probably should've been "under construction". Can we also include in these rules that Cursor should make an effort to scan the associated packages for a release tag?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i tried prompting it locally to do this and it seems to do better (moved the autocomplete changes to under construction and the XL dialog one to S2) so it might be possible even though it can't access the pulls directly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay so...i tried my best to get it to scan for packages and their release tags but it really is a hit or miss. i've found that i have to prompt it again to look more carefully but at least i don't need to specify a specific component package