-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.cursorrules
More file actions
95 lines (82 loc) · 3.41 KB
/
Copy path.cursorrules
File metadata and controls
95 lines (82 loc) · 3.41 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# pp-dev - Cursor Rules
## Commit Message Guidelines
### Format: `<type>(<scope>): <subject>`
- Use imperative mood ("add" not "added")
- Don't capitalize first letter
- No period at the end
- Keep subject concise (50 chars or less)
### Commit Types (choose one):
- **`feat`** - A new feature (triggers MINOR version bump)
- **`fix`** - A bug fix (triggers PATCH version bump)
- **`docs`** - Documentation only changes (NO version bump)
- **`style`** - Code style changes, formatting, etc (NO version bump)
- **`refactor`** - Code refactoring, no functional changes (NO version bump)
- **`perf`** - Performance improvements (NO version bump)
- **`test`** - Adding or updating tests (NO version bump)
- **`chore`** - Maintenance tasks, dependencies, etc (NO version bump)
- **`ci`** - CI/CD configuration changes (NO version bump)
- **`build`** - Build system or external dependency changes (NO version bump)
### Scopes (optional, but recommended):
- **`api`** - API-related changes
- **`auth`** - Authentication/authorization changes
- **`cli`** - CLI-related changes
- **`ui`** - User interface changes (client toolbar)
- **`build`** - Build system changes
- **`ci`** - CI/CD changes
- **`deps`** - Dependency updates
- **`docs`** - Documentation changes
- **`test`** - Testing changes
- **`utils`** - Utility functions
- **`config`** - Configuration changes
- **`plugin`** - Vite plugin changes
- **`middleware`** - Middleware changes
### Examples:
```bash
feat(api): add new authentication middleware
fix(cli): resolve memory leak in data processing
docs(readme): update installation instructions
style: format code according to prettier rules
refactor(utils): extract common validation functions
perf(build): optimize bundle size
test(e2e): add comprehensive login test suite
chore(deps): update all dependencies to latest versions
ci(github): add semantic-release workflow
build(rollup): optimize bundle configuration
```
### Breaking Changes:
```bash
feat(api): change response format structure
BREAKING CHANGE: API now returns data in different structure.
All existing clients must be updated to handle new format.
```
### Body and Footer Guidelines:
- **Body**: Explain WHAT and WHY, not HOW
- **Breaking Changes**: Start footer with "BREAKING CHANGE: <description>"
### Important Notes:
- Only `feat`, `fix`, and `BREAKING CHANGE` trigger version bumps
- Use scopes to indicate which area is affected
- Be descriptive but concise
- Reference related issues when possible
- Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
## General Development Guidelines
### Code Quality:
- Always aim for clean, maintainable architecture
- Focus on areas of the code relevant to the task
- Do not touch code unrelated to the task
- Avoid making major changes to working patterns unless explicitly instructed
- Think about what other methods and areas might be affected by changes
### Semantic Release:
- This project uses semantic-release for automated versioning
- All releases go through Pull Requests (no direct pushes to main)
- Commit messages determine version bumps automatically
- Follow conventional commit format strictly for proper releases
### Project Structure:
- `src/` - Source code
- `src/api/` - MI API integration
- `src/cli.ts` - CLI entry point
- `src/client/` - Browser toolbar client
- `src/lib/` - Core library functions
- `src/plugins/` - Vite plugins
- `bin/` - CLI binary
- `tests/` - E2E tests
- `dist/` - Build output