1- # cursor-rules - 为 Cursor 定制的代码审查规则集
1+ < div align = " center " >
22
3- ![ GitHub stars] ( https://img.shields.io/github/stars/LessUp/cursor-rules?style=social )
4- ![ GitHub forks] ( https://img.shields.io/github/forks/LessUp/cursor-rules?style=social )
5- ![ License] ( https://img.shields.io/github/license/LessUp/cursor-rules )
3+ # cursor-rules
64
7- ** 中文**
5+ ** 为 [ Cursor] ( https://cursor.sh/ ) 编辑器量身打造的代码审查与编码规范规则集**
6+
7+ [ ![ GitHub stars] ( https://img.shields.io/github/stars/LessUp/cursor-rules?style=flat-square&logo=github )] ( https://github.com/LessUp/cursor-rules/stargazers )
8+ [ ![ GitHub forks] ( https://img.shields.io/github/forks/LessUp/cursor-rules?style=flat-square&logo=github )] ( https://github.com/LessUp/cursor-rules/network/members )
9+ [ ![ License] ( https://img.shields.io/github/license/LessUp/cursor-rules?style=flat-square )] ( LICENSE )
10+ [ ![ Rules] ( https://img.shields.io/badge/rules-28-blue?style=flat-square )] ( #-支持的技术栈 )
11+
12+ 帮助开发者和团队统一代码风格、提升代码质量,从而更高效地进行协作开发。
13+
14+ 如果您觉得这个项目有帮助,请给我们一个 ⭐️ Star,这是我们持续维护的最大动力!
15+
16+ </div >
817
918---
1019
11- ` cursor-rules ` 是一个为 [ Cursor ] ( https://cursor.sh/ ) 编辑器量身打造的代码审查与编码规范规则集。我们旨在帮助开发者和团队统一代码风格、提升代码质量,从而更高效地进行协作开发。
20+ ## 📖 目录
1221
13- 如果您觉得这个项目对您有帮助,请给我们一个 ⭐️ Star,这是我们持续维护的最大动力!
22+ - [ 核心优势] ( #-核心优势 )
23+ - [ 支持的技术栈] ( #-支持的技术栈 )
24+ - [ 快速开始] ( #-快速开始 )
25+ - [ 规则文件说明] ( #-规则文件说明 )
26+ - [ 贡献指南] ( #-贡献指南 )
27+ - [ 许可证] ( #-许可证 )
28+ - [ 致谢] ( #-致谢 )
1429
1530## ✨ 核心优势
1631
17- - ** ✍️ 统一规范** :遵循业界广泛认可的最佳实践,确保团队代码风格一致。
18- - ** 🚀 开箱即用** :只需简单配置,即可在您的 Cursor 编辑器中启用。
19- - ** 💡 智能审查** :利用 Cursor 的 AI 能力,实时获得代码改进建议。
20- - ** 🧩 高度可扩展** :轻松定制或添加新规则,以满足您团队的个性化需求。
32+ | | 特性 | 说明 |
33+ | :---: | :--- | :--- |
34+ | ✍️ | ** 统一规范** | 遵循业界广泛认可的最佳实践,确保团队代码风格一致 |
35+ | 🚀 | ** 开箱即用** | 只需简单配置,即可在 Cursor 编辑器中启用 |
36+ | 💡 | ** 智能审查** | 结合 Cursor 的 AI 能力,实时获得代码改进建议 |
37+ | 🧩 | ** 高度可扩展** | 轻松定制或添加新规则,满足团队个性化需求 |
2138
2239## 🛠️ 支持的技术栈
2340
24- 我们目前支持以下语言和框架的规则集:
41+ ### 编程语言
42+
43+ | 技术 | 规则文件 |
44+ | :--- | :--- |
45+ | Python | [ ` python.mdc ` ] ( python.mdc ) |
46+ | Java | [ ` java.mdc ` ] ( java.mdc ) |
47+ | Go | [ ` go.mdc ` ] ( go.mdc ) |
48+ | C# / .NET | [ ` csharp-dotnet.mdc ` ] ( csharp-dotnet.mdc ) |
49+ | Ruby | [ ` ruby.mdc ` ] ( ruby.mdc ) |
50+ | PHP | [ ` php.mdc ` ] ( php.mdc ) |
51+ | C++ | [ ` cpp.mdc ` ] ( cpp.mdc ) |
52+ | TypeScript | [ ` typescript.mdc ` ] ( typescript.mdc ) |
53+
54+ ### 后端框架
55+
56+ | 技术 | 规则文件 |
57+ | :--- | :--- |
58+ | Node.js / Express | [ ` node-express.mdc ` ] ( node-express.mdc ) |
59+ | Spring | [ ` spring.mdc ` ] ( spring.mdc ) |
60+ | FastAPI | [ ` fastapi.mdc ` ] ( fastapi.mdc ) |
61+
62+ ### 前端框架
63+
64+ | 技术 | 规则文件 |
65+ | :--- | :--- |
66+ | React | [ ` react.mdc ` ] ( react.mdc ) |
67+ | Vue | [ ` vue.mdc ` ] ( vue.mdc ) |
68+ | Svelte | [ ` svelte.mdc ` ] ( svelte.mdc ) |
69+ | Next.js | [ ` nextjs.mdc ` ] ( nextjs.mdc ) |
70+ | Tailwind CSS | [ ` tailwind.mdc ` ] ( tailwind.mdc ) |
71+ | Medusa | [ ` medusa.mdc ` ] ( medusa.mdc ) |
2572
26- | 分类 | 技术栈 | 对应文件 |
27- | :--- | :--- | :--- |
28- | ** 编程语言** | Python, Java, Go, C#, Ruby, PHP, C++, TypeScript | ` python.mdc ` , ` java.mdc ` , ` go.mdc ` , ` csharp-dotnet.mdc ` , ` ruby.mdc ` , ` php.mdc ` , ` cpp.mdc ` , ` typescript.mdc ` |
29- | ** 后端框架** | Node.js/Express, Spring, FastAPI | ` node-express.mdc ` , ` spring.mdc ` , ` fastapi.mdc ` |
30- | ** 前端框架** | React, Vue, Svelte, Next.js, Tailwind CSS, Medusa | ` react.mdc ` , ` vue.mdc ` , ` svelte.mdc ` , ` nextjs.mdc ` , ` tailwind.mdc ` , ` medusa.mdc ` |
31- | ** 移动端** | Android, iOS, 微信小程序, NativeScript | ` android.mdc ` , ` ios.mdc ` , ` wechat-miniprogram.mdc ` , ` nativescript.mdc ` |
32- | ** 数据库** | Prisma, Supabase, 通用数据库设计 | ` database.mdc ` |
33- | ** DevOps** | Docker | ` docker.mdc ` |
34- | ** 通用规范** | 整洁代码, 代码质量, Git Flow | ` clean-code.mdc ` , ` codequality.mdc ` , ` gitflow.mdc ` |
73+ ### 移动端
3574
36- ## 🚀 使用指南
75+ | 技术 | 规则文件 |
76+ | :--- | :--- |
77+ | Android | [ ` android.mdc ` ] ( android.mdc ) |
78+ | iOS | [ ` ios.mdc ` ] ( ios.mdc ) |
79+ | 微信小程序 | [ ` wechat-miniprogram.mdc ` ] ( wechat-miniprogram.mdc ) |
80+ | NativeScript | [ ` nativescript.mdc ` ] ( nativescript.mdc ) |
81+
82+ ### 基础设施与工程化
83+
84+ | 技术 | 规则文件 |
85+ | :--- | :--- |
86+ | 数据库设计 | [ ` database.mdc ` ] ( database.mdc ) |
87+ | Docker | [ ` docker.mdc ` ] ( docker.mdc ) |
88+
89+ ### 通用规范
90+
91+ | 技术 | 规则文件 |
92+ | :--- | :--- |
93+ | 整洁代码 | [ ` clean-code.mdc ` ] ( clean-code.mdc ) |
94+ | 代码质量 | [ ` codequality.mdc ` ] ( codequality.mdc ) |
95+ | Git Flow | [ ` gitflow.mdc ` ] ( gitflow.mdc ) |
96+
97+ ## 🚀 快速开始
3798
3899### 方式一:直接复制到项目(推荐)
39100
40- 1 . 在您的项目根目录下创建 ` .cursor/rules/ ` 目录。
41- 2 . 将您需要的 ` .mdc ` 文件复制到该目录中。
42- 3 . Cursor 会自动识别并应用这些规则。
101+ ``` bash
102+ # 1. 在项目根目录下创建规则目录
103+ mkdir -p .cursor/rules
104+
105+ # 2. 复制所需的规则文件(以 Python + Clean Code 为例)
106+ cp path/to/cursor-rules/python.mdc .cursor/rules/
107+ cp path/to/cursor-rules/clean-code.mdc .cursor/rules/
108+
109+ # Cursor 会自动识别并应用这些规则 ✅
110+ ```
111+
112+ ### 方式二:Git Submodule(便于同步更新)
43113
44114``` bash
45- # 示例:将 Python 和 Clean Code 规则复制到项目中
115+ # 1. 将本仓库作为子模块添加到项目中
116+ git submodule add https://github.com/LessUp/cursor-rules.git .cursor/cursor-rules
117+
118+ # 2. 将所需规则软链接到 rules 目录
46119mkdir -p .cursor/rules
47- cp python.mdc clean-code.mdc .cursor/rules/
120+ ln -s ../cursor-rules/python.mdc .cursor/rules/python.mdc
121+
122+ # 后续同步更新
123+ git submodule update --remote
48124```
49125
50- ### 方式二 :通过 Cursor 设置导入
126+ ### 方式三 :通过 Cursor 设置导入
51127
521281 . 打开 Cursor 编辑器。
53- 2 . 进入 ` Settings ` > ` Cursor Settings ` > ` Rules ` 。
54- 3 . 点击 ` Add Rule ` ,将 ` .mdc ` 文件的内容粘贴到规则编辑器中。
129+ 2 . 进入 ** Settings** → ** Cursor Settings** → ** Rules** 。
130+ 3 . 点击 ** Add Rule** ,将 ` .mdc ` 文件的内容粘贴到规则编辑器中。
55131
56- ### 规则文件说明
132+ ## 📄 规则文件说明
57133
58- 每个 ` .mdc ` 文件包含两部分 :
134+ 每个 ` .mdc ` 文件由两部分组成 :
59135
60- - ** Frontmatter** (` --- ` 之间的内容):定义规则的描述和适用的文件类型(` globs ` )。
61- - ** 规则正文** :具体的编码规范和最佳实践指南。
62-
63- 当 ` globs ` 不为空时,规则仅在匹配的文件类型上生效;当 ` globs ` 为空时,规则作为通用规范全局生效。
136+ ``` markdown
137+ ---
138+ description: 规则集用途的简短描述
139+ globs: ** /* .py, src/** /* .py # 适用的文件类型
140+ ---
64141
65- ## 📜 许可证
142+ # 规则正文:具体的编码规范和最佳实践
143+ ```
66144
67- 本项目采用 MIT 许可证。详情请见 [ LICENSE] ( LICENSE ) 文件。
145+ - ** ` globs ` 不为空** → 规则仅在匹配的文件类型上生效(如 ` **/*.py ` 只对 Python 文件生效)。
146+ - ** ` globs ` 为空** → 规则作为通用规范全局生效。
68147
69148## 🤝 贡献指南
70149
71- 我们非常欢迎社区的贡献!您可以通过以下方式参与项目:
150+ 我们非常欢迎社区的贡献!
151+
152+ ### 参与方式
72153
73154- ** 提交 Issue** :发现问题或有新想法?请在 [ Issues] ( https://github.com/LessUp/cursor-rules/issues ) 中告诉我们。
74155- ** 提交 Pull Request** :
75- 1 . Fork 本仓库。
76- 2 . 创建您的特性分支 ( ` git checkout -b feature/AmazingFeature ` )。
77- 3 . 提交您的更改 ( ` git commit -m 'Add some AmazingFeature' ` )。
78- 4 . 推送到分支 ( ` git push origin feature/AmazingFeature ` )。
79- 5 . 打开一个 Pull Request。
156+ 1 . Fork 本仓库
157+ 2 . 创建特性分支: ` git checkout -b feature/AmazingFeature `
158+ 3 . 提交更改: ` git commit -m 'Add some AmazingFeature' `
159+ 4 . 推送分支: ` git push origin feature/AmazingFeature `
160+ 5 . 打开一个 Pull Request
80161
81162### 编写新规则的规范
82163
83- 如果您想贡献新的规则文件,请遵循以下格式 :
164+ 贡献新规则时,请遵循以下模板 :
84165
85166``` markdown
86167---
@@ -96,10 +177,18 @@ globs: **/*.ext, src/**/*.ext
96177- 提供代码示例和配置参考
97178```
98179
180+ ## 📜 许可证
181+
182+ 本项目采用 [ MIT] ( LICENSE ) 许可证 — 可自由使用、修改和分发。
183+
99184## ❤️ 致谢
100185
101186感谢所有为这个项目做出贡献的开发者!
102187
103188---
104189
190+ <div align =" center " >
191+
105192** 喜欢这个项目吗?请给我们一个 [ ⭐️ Star] ( https://github.com/LessUp/cursor-rules/stargazers ) !**
193+
194+ </div >
0 commit comments