Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .cursor/rules/release-notes.mdc
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
Copy link
Member

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?

Copy link
Member

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?

Copy link
Member Author

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

| 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)

### 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