-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.cursorrules
More file actions
69 lines (47 loc) · 2.24 KB
/
.cursorrules
File metadata and controls
69 lines (47 loc) · 2.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# shadcn instructions
Use the latest version of Shadcn to install new components, like this command to add a button component:
```bash
pnpx shadcn@latest add button
```
# Conventional Commits Specification (v1.0.0)
When creating commit messages, ALWAYS follow the Conventional Commits specification (https://www.conventionalcommits.org/en/v1.0.0/).
## Commit Message Structure
```
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```
## Required Elements
1. **Type**: MUST be prefixed with a type, followed by a colon and space
- `feat`: A new feature (correlates with MINOR in Semantic Versioning)
- `fix`: A bug fix (correlates with PATCH in Semantic Versioning)
- Other types allowed: `build`, `chore`, `ci`, `docs`, `style`, `refactor`, `perf`, `test`, etc.
2. **Description**: MUST immediately follow the colon and space. Short summary of code changes.
## Optional Elements
1. **Scope**: MAY be provided after type, enclosed in parentheses
- Example: `feat(parser): add ability to parse arrays`
- Example: `fix(api): resolve authentication error`
2. **Body**: MAY be provided after description, separated by blank line
- Free-form, can contain multiple paragraphs
- Provides additional contextual information
3. **Footer**: MAY be provided after body, separated by blank line
- Uses format: `Token: value` or `Token #value`
- Special footer: `BREAKING CHANGE: description` for breaking changes
## Breaking Changes
Breaking changes MUST be indicated in one of two ways:
1. Append `!` after type/scope: `feat!: send email on product shipped`
2. Include footer: `BREAKING CHANGE: description`
## Examples
- `feat: allow provided config object to extend other configs`
- `fix: prevent racing of requests`
- `feat(api)!: send an email when product is shipped`
- `docs: correct spelling of CHANGELOG`
- `feat(lang): add Polish language`
- `chore!: drop support for Node 6`
- `fix(parser): array parsing issue when multiple spaces contained`
## Rules
- Types are case-insensitive (but be consistent)
- Scope is optional but recommended for clarity
- Description should be concise and in imperative mood
- Always use this format - no exceptions
- When suggesting commits, always format them according to this specification