Skip to content

Commit 4506478

Browse files
committed
chore(ide): add conventional commits rule for Cursor
1 parent 439c44a commit 4506478

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
description: This rule defines the format for creating commit messages
3+
globs:
4+
alwaysApply: false
5+
---
6+
## Conventional Commits
7+
8+
The `conventional-commits` rule enforces the use of conventional commit message format, which is required for semantic versioning and automatic changelog generation.
9+
10+
### Format
11+
12+
Commit messages must follow this format:
13+
```
14+
<type>[(scope)]: <description>
15+
```
16+
17+
### Types
18+
- `feat`: A new feature
19+
- `fix`: A bug fix
20+
- `docs`: Documentation changes
21+
- `style`: Changes that do not affect the meaning of the code
22+
- `refactor`: Code changes that neither fix a bug nor add a feature
23+
- `perf`: Performance improvements
24+
- `test`: Adding or fixing tests
25+
- `chore`: Changes to the build process or auxiliary tools
26+
- `ci`: Changes to CI configuration
27+
- `revert`: Reverting a previous commit
28+
- `build`: Changes that affect the build system
29+
30+
### Example Valid Commit Messages
31+
- `feat: add user authentication`
32+
- `fix(auth): resolve token expiration issue`
33+
- `docs: update API documentation`
34+
- `chore(deps): update dependencies`

0 commit comments

Comments
 (0)