Skip to content

Commit 9a1aabb

Browse files
author
shijiashuai
committed
docs: 完善 README 文档
- 修复 translation-progress.md 死链和 emoji 渲染异常 - 修正项目统计数据 (43 领域、92 规则文件、550+ 总文件) - 扩展规则集目录表格,覆盖全部 43 个分类(7 组分组) - 新增目录导航、.cursorrules 概念介绍、项目结构概览 - 新增 FAQ 常见问题(可折叠)和相关文档索引表格 - 优化整体结构和排版,增强可读性
1 parent 7197a9f commit 9a1aabb

1 file changed

Lines changed: 219 additions & 21 deletions

File tree

README.md

Lines changed: 219 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,39 @@
33
<div align="center">
44

55
[![项目状态](https://img.shields.io/badge/status-completed-green?style=for-the-badge)](https://github.com/LessUp/awesome-cursorrules-zh)
6-
[![翻译进度](https://img.shields.io/badge/progress-100%25-brightgreen?style=for-the-badge)](./docs/translation-progress.md)
6+
[![翻译进度](https://img.shields.io/badge/progress-100%25-brightgreen?style=for-the-badge)](https://github.com/LessUp/awesome-cursorrules-zh)
77
[![GitHub Stars](https://img.shields.io/github/stars/LessUp/awesome-cursorrules-zh?style=for-the-badge&logo=github&label=Stars)](https://github.com/LessUp/awesome-cursorrules-zh/stargazers)
88
[![Fork](https://img.shields.io/github/forks/LessUp/awesome-cursorrules-zh?style=for-the-badge&logo=github&label=Fork)](https://github.com/LessUp/awesome-cursorrules-zh/network/members)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](./LICENSE)
1010
[![贡献指南](https://img.shields.io/badge/Contributing-Welcome-brightgreen.svg?style=for-the-badge)](./CONTRIBUTING.md)
1111

1212
**一个由社区驱动、为中文开发者量身打造的 [Cursor](https://cursor.sh/) AI 编程规则集合。**
1313

14-
**所有规则集已完成高质量翻译,涵盖 40+ 技术领域、450+ 规则文件。**
14+
**所有规则集已完成高质量翻译,涵盖 43 个技术领域、550+ 规则文件。**
1515

16-
[🚀 快速开始](#-快速开始) · [📂 规则集目录](#-规则集目录) · [💡 使用指南](#-使用指南与最佳实践) · [🤝 参与贡献](#-参与贡献)
16+
[🚀 快速开始](#-快速开始) · [📂 规则集目录](#-规则集目录) · [💡 使用指南](#-使用指南与最佳实践) · [❓ 常见问题](#-常见问题) · [🤝 参与贡献](#-参与贡献)
1717

1818
</div>
1919

2020
---
2121

22+
## 📖 目录
23+
24+
- [这是什么?](#-这是什么)
25+
- [什么是 .cursorrules?](#-什么是-cursorrules)
26+
- [项目亮点](#-项目亮点)
27+
- [快速开始](#-快速开始)
28+
- [规则集目录](#-规则集目录)
29+
- [项目结构](#-项目结构)
30+
- [使用指南与最佳实践](#-使用指南与最佳实践)
31+
- [项目现状与未来计划](#-项目现状与未来计划)
32+
- [常见问题](#-常见问题)
33+
- [参与贡献](#-参与贡献)
34+
- [致谢](#-致谢)
35+
- [许可证](#-许可证)
36+
37+
---
38+
2239
## 🤔 这是什么?
2340

2441
[Awesome Cursor Rules](https://github.com/PatrickJS/awesome-cursorrules) 是一个优秀的 Cursor AI 编程助手规则集合,但原项目主要面向英文用户。本项目致力于:
@@ -27,13 +44,24 @@
2744
2. **结构优化** — 按技术领域重新组织目录结构,方便快速查找。
2845
3. **内容增强** — 补充更符合国内技术生态的规则和最佳实践。
2946

47+
## 📌 什么是 .cursorrules?
48+
49+
`.cursorrules`[Cursor](https://cursor.sh/) AI 代码编辑器的项目级配置文件。将该文件放在项目根目录下,Cursor 的 AI 助手会自动读取其中的规则,从而:
50+
51+
- **遵循编码规范** — 按照你指定的代码风格、命名约定、架构模式生成代码。
52+
- **了解技术栈** — 知道项目使用的框架、库和工具链,给出更精准的建议。
53+
- **提升代码质量** — 自动应用最佳实践,减少低质量代码的产出。
54+
55+
> 💡 简单来说,`.cursorrules` 就是你给 AI 助手写的一份"工作手册"——告诉它你的项目该怎么写代码。
56+
3057
## 🌟 项目亮点
3158

3259
- **🎯 专为中文优化** — 所有规则经过精心翻译和本地化,术语准确,符合中文语境。
33-
- **🗂️ 清晰的结构** — 按技术领域分类,覆盖前端、后端、AI、DevOps 等 40+ 方向
60+
- **🗂️ 清晰的结构** — 按技术领域分类,覆盖前端、后端、AI、DevOps 等 43 个方向
3461
- **✅ 开箱即用** — 将 `.cursorrules` 文件复制到项目根目录即可生效。
3562
- **📈 社区驱动** — 欢迎任何人参与贡献,共同打造最好的中文规则库。
3663
- **🛡️ 质量保障** — 自动化校验脚本 + 术语一致性检查 + 严格的 PR 审核流程。
64+
- **📦 规模丰富** — 92 个 `.cursorrules` 规则文件,550+ 技术文档,覆盖主流与前沿领域。
3765

3866
## 🚀 快速开始
3967

@@ -66,23 +94,112 @@ cp rules/frontend/react/nextjs-typescript/.cursorrules /path/to/your/project/
6694

6795
## 📂 规则集目录
6896

69-
我们提供了覆盖 **40+ 技术领域** 的规则集:
97+
我们提供了覆盖 **43 个技术领域** 的规则集,以下按类别分组展示:
98+
99+
### 🖥️ 应用开发
100+
101+
| 领域 | 目录 | 说明 |
102+
|------|------|------|
103+
| **前端开发** | [`frontend/`](./rules/frontend/) | React, Vue, Angular, Svelte, SolidJS, TypeScript, 微前端 等 (214 个文件) |
104+
| **后端开发** | [`backend/`](./rules/backend/) | Node.js, Python, Go, Java, Kotlin, .NET, PHP, Elixir 等 (132 个文件) |
105+
| **移动开发** | [`mobile/`](./rules/mobile/) | Flutter, React Native, SwiftUI, Android Jetpack Compose (30 个文件) |
106+
| **数据库** | [`database/`](./rules/database/) | 云原生数据库、时空数据库 |
107+
| **CMS** | [`cms/`](./rules/cms/) | Drupal 内容管理系统 |
108+
| **系统编程** | [`systems/`](./rules/systems/) | C++ 现代编程规范 |
109+
110+
### 🤖 AI 与数据
70111

71112
| 领域 | 目录 | 说明 |
72113
|------|------|------|
73-
| **前端开发** | [`frontend/`](./rules/frontend/) | React, Vue, Angular, Svelte, Next.js, Nuxt 等 200+ 规则 |
74-
| **后端开发** | [`backend/`](./rules/backend/) | Node.js, Python, Go, Java, .NET, Rust 等 120+ 规则 |
75-
| **移动开发** | [`mobile/`](./rules/mobile/) | React Native, Flutter, iOS, Android 等 |
76-
| **DevOps** | [`devops/`](./rules/devops/) | Docker, Kubernetes, CI/CD, Terraform 等 |
77-
| **AI / 机器学习** | [`ai/`](./rules/ai/) | PyTorch, TensorFlow, LLM, 数据科学 等 |
78-
| **数据科学** | [`data-science/`](./rules/data-science/) | Pandas, Matplotlib, Scikit-learn 等 |
79-
| **数据库** | [`database/`](./rules/database/) | SQL, NoSQL, ORM 等 |
80-
| **区块链** | [`blockchain/`](./rules/blockchain/) | Solidity, Web3, 智能合约 等 |
81-
| **安全** | [`security/`](./rules/security/) | 安全编码、漏洞检测 等 |
82-
| **IoT / 边缘计算** | [`iot/`](./rules/iot/) [`edge/`](./rules/edge/) | 物联网、边缘计算 等 |
83-
| **通用规则** | [`general/`](./rules/general/) | 代码规范、风格指南、Git 约定 等 |
84-
85-
> 📋 完整目录请浏览 [`rules/`](./rules/) 文件夹,还包括 `cloud/``gaming/``quantum/``robotics/``hardware/` 等更多领域。
114+
| **AI / 机器学习** | [`ai/`](./rules/ai/) | 计算机视觉、边缘 AI、联邦学习、知识图谱、MLOps、光子神经网络 |
115+
| **数据科学** | [`data-science/`](./rules/data-science/) | Python 数据处理、Pandas、Matplotlib |
116+
| **数据工程** | [`data/`](./rules/data/) | 数据仓库、Kafka/Pulsar、Spark/Flink |
117+
118+
### ⚙️ 基础设施与运维
119+
120+
| 领域 | 目录 | 说明 |
121+
|------|------|------|
122+
| **DevOps** | [`devops/`](./rules/devops/) | Docker, Kubernetes, CI/CD, Terraform, Serverless, 服务网格, 可观测性 等 (40 个文件) |
123+
| **云服务** | [`cloud/`](./rules/cloud/) | 中间件 |
124+
| **边缘计算** | [`edge/`](./rules/edge/) | AI 推理、边缘计算、模型压缩 |
125+
| **分布式计算** | [`compute/`](./rules/compute/) | 分布式系统 |
126+
| **网络** | [`network/`](./rules/network/) | 卫星互联网 |
127+
| **存储** | [`storage/`](./rules/storage/) | DNA 存储 |
128+
129+
### 🔗 专业领域
130+
131+
| 领域 | 目录 | 说明 |
132+
|------|------|------|
133+
| **区块链** | [`blockchain/`](./rules/blockchain/) | Solidity, Web3, 智能合约安全, 高级协议 |
134+
| **安全** | [`security/`](./rules/security/) | 同态加密、隐私计算、安全多方计算、零信任 等 |
135+
| **IoT / 物联网** | [`iot/`](./rules/iot/) | 数字孪生、嵌入式开发、IoT 平台 |
136+
| **游戏开发** | [`gaming/`](./rules/gaming/) | 云游戏 |
137+
| **AR / VR** | [`ar-vr/`](./rules/ar-vr/) | 增强现实 |
138+
139+
### 🔬 前沿科技
140+
141+
| 领域 | 目录 | 说明 |
142+
|------|------|------|
143+
| **量子计算** | [`quantum/`](./rules/quantum/) | 量子纠错、超导量子计算 |
144+
| **机器人** | [`robotics/`](./rules/robotics/) | ROS 机器人操作系统 |
145+
| **硬件** | [`hardware/`](./rules/hardware/) | 碳基芯片、神经形态芯片、光子计算、超导存储 |
146+
| **生物科技** | [`bio/`](./rules/bio/) | 生物电子、生物 CPU、生物传感器融合 |
147+
| **新兴技术** | [`emerging-tech/`](./rules/emerging-tech/) | 生物计算、量子通信、量子计算 |
148+
| **科学计算** | [`science/`](./rules/science/) | 生物信息学 |
149+
| **仿真模拟** | [`simulation/`](./rules/simulation/) | 数字孪生仿真 |
150+
151+
### 🏢 平台与自动化
152+
153+
| 领域 | 目录 | 说明 |
154+
|------|------|------|
155+
| **平台开发** | [`platform/`](./rules/platform/) | 低代码、无代码、元宇宙 |
156+
| **工业自动化** | [`industrial/`](./rules/industrial/) | 工业自动化 |
157+
| **流程自动化** | [`automation/`](./rules/automation/) | RPA 机器人流程自动化 |
158+
159+
### 📋 通用与独立规则集
160+
161+
| 领域 | 目录 | 说明 |
162+
|------|------|------|
163+
| **通用规则** | [`general/`](./rules/general/) | 代码规范指南、Git 约定 |
164+
| **代码规范** | [`code-guidelines-cursorrules-prompt-file/`](./rules/code-guidelines-cursorrules-prompt-file/) | 代码规范提示 |
165+
| **代码风格** | [`code-style-consistency-cursorrules-prompt-file/`](./rules/code-style-consistency-cursorrules-prompt-file/) | 代码风格一致性 |
166+
| **结对面试** | [`code-pair-interviews/`](./rules/code-pair-interviews/) | 编程面试助手 |
167+
| **Convex** | [`convex-cursorrules-prompt-file/`](./rules/convex-cursorrules-prompt-file/) | Convex 后端平台 |
168+
| **DragonRuby** | [`dragonruby-best-practices-cursorrules-prompt-file/`](./rules/dragonruby-best-practices-cursorrules-prompt-file/) | DragonRuby 游戏引擎最佳实践 |
169+
| **Git 提交** | [`git-conventional-commit-messages/`](./rules/git-conventional-commit-messages/) | 约定式提交消息 |
170+
| **测试相关** | [`gherkin-style-testing-cursorrules-prompt-file/`](./rules/gherkin-style-testing-cursorrules-prompt-file/) [`xray-test-case-cursorrules-prompt-file/`](./rules/xray-test-case-cursorrules-prompt-file/) | Gherkin 风格测试、Xray 测试用例 |
171+
| **工程模板** | [`engineering-ticket-template-cursorrules-prompt-file/`](./rules/engineering-ticket-template-cursorrules-prompt-file/) | 工程工单模板 |
172+
173+
> 📋 完整目录请浏览 [`rules/`](./rules/) 文件夹查看所有规则集。
174+
175+
## 🏗️ 项目结构
176+
177+
```
178+
awesome-cursorrules-zh/
179+
├── rules/ # 所有规则集(按技术领域分类)
180+
│ ├── frontend/ # 前端 (React, Vue, Angular, Svelte ...)
181+
│ ├── backend/ # 后端 (Node.js, Python, Go, Java ...)
182+
│ ├── mobile/ # 移动端 (Flutter, React Native ...)
183+
│ ├── devops/ # DevOps (Docker, K8s, Terraform ...)
184+
│ ├── ai/ # AI / 机器学习
185+
│ ├── security/ # 安全
186+
│ └── ... # 更多领域 (共 43 个分类)
187+
├── docs/ # 项目文档
188+
│ ├── getting-started.md # 快速开始指南
189+
│ ├── best-practices.md # 最佳实践
190+
│ ├── installation-guide.md # 安装指南
191+
│ └── troubleshooting.md # 故障排除
192+
├── scripts/ # 自动化工具
193+
│ └── validate_translations.py # 翻译质量校验脚本
194+
├── .github/ # GitHub 配置
195+
│ ├── workflows/ # CI/CD 质量检查
196+
│ ├── ISSUE_TEMPLATE/ # Issue 模板
197+
│ └── pull_request_template.md
198+
├── CONTRIBUTING.md # 贡献指南
199+
├── CODE_OF_CONDUCT.md # 行为准则
200+
├── CHANGELOG.md # 更新日志
201+
└── README.md # 本文件
202+
```
86203

87204
## 💡 使用指南与最佳实践
88205

@@ -138,29 +255,110 @@ your-project/
138255
| **翻译进度** | ✅ 100% 完成 |
139256
| **质量状态** | ✅ 高质量翻译,已审核 |
140257
| **最新版本** | v1.5.0 |
141-
| **详细报告** | [翻译进度报告](./docs/translation-progress.md) |
258+
| **技术领域** | 43 个分类 |
259+
| **规则文件** | 92 个 `.cursorrules` 文件 |
260+
| **总文件数** | 550+ 个技术文档 |
261+
| **更新日志** | [CHANGELOG.md](./CHANGELOG.md) |
142262

143263
项目已进入**持续维护和优化阶段**,未来工作重点:
144264

145265
- **同步上游更新** — 定期与 [原项目](https://github.com/PatrickJS/awesome-cursorrules) 保持同步,引入新规则。
146266
- **质量优化** — 根据社区反馈,持续改进翻译质量和规则的实用性。
147267
- **文档完善** — 优化使用指南和项目文档,提升用户体验。
148268

269+
## ❓ 常见问题
270+
271+
<details>
272+
<summary><b>Q: .cursorrules 文件放在哪里?</b></summary>
273+
274+
`.cursorrules` 文件放在**项目根目录**下。Cursor 打开项目后会自动检测并加载该文件。
275+
276+
</details>
277+
278+
<details>
279+
<summary><b>Q: 规则不生效怎么办?</b></summary>
280+
281+
1. 确认 `.cursorrules` 文件在项目根目录(不是仓库根目录)
282+
2. 重启 Cursor 编辑器
283+
3. 检查文件编码为 UTF-8
284+
4. 确保 Cursor 设置中"Use .cursorrules"选项已启用
285+
286+
更多排查方法请参阅 [故障排除指南](./docs/troubleshooting.md)
287+
288+
</details>
289+
290+
<details>
291+
<summary><b>Q: 可以同时使用多个规则文件吗?</b></summary>
292+
293+
Cursor 按目录层级查找 `.cursorrules` 文件,子目录的规则会覆盖父目录的规则。你可以利用这个机制为不同子项目设置不同规则:
294+
295+
```
296+
your-project/
297+
├── .cursorrules # 通用规则
298+
├── frontend/
299+
│ └── .cursorrules # 前端规则(优先于根目录规则)
300+
└── backend/
301+
└── .cursorrules # 后端规则(优先于根目录规则)
302+
```
303+
304+
</details>
305+
306+
<details>
307+
<summary><b>Q: 如何选择适合自己项目的规则集?</b></summary>
308+
309+
- **新项目** — 选择对应技术栈的完整规则集,例如 `nextjs-typescript`
310+
- **现有项目** — 从 `general/code-guidelines` 通用规则开始,逐步引入特定规则。
311+
- **多技术栈** — 可以合并多个规则文件或使用目录特定规则。
312+
313+
详细指导请查阅 [最佳实践](./docs/best-practices.md)
314+
315+
</details>
316+
317+
<details>
318+
<summary><b>Q: 这些规则只能用于 Cursor 吗?</b></summary>
319+
320+
`.cursorrules` 是 Cursor 编辑器的专有格式。但规则文件本质上是纯文本的编码指南,其中的最佳实践和编码规范**同样适用于**其他 AI 编码助手(如 GitHub Copilot、Windsurf 等),只需按目标工具的格式稍作调整即可。
321+
322+
</details>
323+
324+
<details>
325+
<summary><b>Q: 如何贡献翻译或改进?</b></summary>
326+
327+
1. Fork 本仓库
328+
2. 创建分支:`git checkout -b fix/your-improvement`
329+
3. 进行修改并提交 Pull Request
330+
331+
详情请阅读 [贡献指南](./CONTRIBUTING.md)
332+
333+
</details>
334+
149335
## 🤝 参与贡献
150336

151337
我们欢迎各种形式的贡献!
152338

153339
- **🐛 报告问题** — 发现翻译不准确或规则已过时?请通过 [Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 告诉我们。
154340
- **🔧 改进翻译** — 提交 Pull Request 帮助优化现有内容。
155341
- **🔄 同步上游** — 帮助项目与 [原版](https://github.com/PatrickJS/awesome-cursorrules) 保持同步。
342+
- **📝 完善文档** — 改进使用指南、添加使用示例、优化项目文档。
156343

157344
在开始之前,请阅读 [**贡献指南**](./CONTRIBUTING.md)[**行为准则**](./CODE_OF_CONDUCT.md)
158345

159346
## 🐛 遇到问题?
160347

161348
请查阅 [**故障排除指南**](./docs/troubleshooting.md),里面包含常见问题的解决方案和诊断工具。
162349

163-
## 🙏 致谢
350+
## 📚 相关文档
351+
352+
| 文档 | 说明 |
353+
|------|------|
354+
| [快速开始指南](./docs/getting-started.md) | 从零开始使用规则集的完整教程 |
355+
| [最佳实践](./docs/best-practices.md) | 规则选择、配置和团队协作的最佳实践 |
356+
| [安装指南](./docs/installation-guide.md) | 详细的环境安装与配置说明 |
357+
| [故障排除](./docs/troubleshooting.md) | 常见问题诊断与解决方案 |
358+
| [贡献指南](./CONTRIBUTING.md) | 参与项目贡献的流程与规范 |
359+
| [更新日志](./CHANGELOG.md) | 项目版本历史与变更记录 |
360+
361+
## � 致谢
164362

165363
感谢 [awesome-cursorrules](https://github.com/PatrickJS/awesome-cursorrules) 原项目提供的优秀基础。
166364

@@ -174,7 +372,7 @@ your-project/
174372

175373
<div align="center">
176374

177-
**如果这个项目对你有帮助,请给我们一个 ⭐**
375+
**如果这个项目对你有帮助,请给我们一个 ⭐ Star**
178376

179377
**让更多中文开发者受益于优质的 AI 编程规则!**
180378

0 commit comments

Comments
 (0)