Skip to content

Commit f9af21c

Browse files
committed
chore: add cursor rule for release notes
1 parent c6869db commit f9af21c

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

.cursor/rules/release-notes.mdc

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
description: Use when formatting commit messages for release notes
3+
globs:
4+
alwaysApply: false
5+
---
6+
7+
Given a list of commit messages, follow the steps to process them.
8+
9+
## Step 1: Categorize Commits
10+
11+
Sort ALL commit messages into one of six main categories. The main categories are the following:
12+
- Enhancements
13+
- Fixes
14+
- Documentation
15+
- Under Construction
16+
- To Be Categorized
17+
- S2
18+
19+
### Categorization Rules:
20+
Use the following keywords to determine the category:
21+
| Keyword | Category |
22+
|----------------------------|----------|
23+
| feat | Enhancements|
24+
| fix | Fixes |
25+
| docs | Documentation |
26+
| alpha, beta, rc | Under Construction
27+
| chore, revert, bump, build | To Be Categorized |
28+
| S2 | S2 |
29+
30+
Each category name must be written as a Markdown H2 heading using ##.
31+
32+
## Step 2: Rewrite commit messages
33+
34+
Original format: Type (Scope): Summary of changes - [@username](link to username) - [PR](link to PR)
35+
New Format: Summary of changes - [@username](link to username) - [PR](link to PR)
36+
37+
### General Guidelines:
38+
- Keep the summary as a single, grammatically correct sentence
39+
- The message should be concise and easy to read
40+
- Wrap any camelCase or code-like terms (e.g. onClick, onAction, isDisabled) in backticks (`)
41+
- Do NOT use backticks for component names
42+
- Replace specific terms:
43+
- RAC -> React Aria
44+
- V3 -> React Spectrum
45+
- ALWAYS capitalize UI component names
46+
- Example:
47+
- toast -> Toast
48+
- inline alert -> InlineAlert
49+
50+
### Component Names to Capitalize:
51+
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.
52+
53+
54+
## Step 3: Add Sub-headings
55+
56+
Within the Enhancements, Fixes, and Under Construction categories, group commits by UI component under sub-headings.
57+
58+
### Sub-heading rules:
59+
- Use sub-headings ONLY for:
60+
- Enhancements
61+
- Fixes
62+
- Under Construction
63+
- Do NOT create sub-headings for:
64+
- Documentation
65+
- To Be Categorized
66+
- S2
67+
- Sub-headings should be in alphabetical order
68+
- Use "Miscellaneous" as a sub-heading for commits that do not belong to a specific component
69+
- Each category can have its own Miscellaneous sub-heading
70+
- Write sub-headings and commits as unordered lists using a hyphen (-)
71+
- Do NOT bold the sub-heading text

0 commit comments

Comments
 (0)