Skip to content

Commit 7197a9f

Browse files
author
shijiashuai
committed
docs: 全面优化 README.md 结构与内容
- 修复顶部导航锚点链接失效问题 - 重新组织章节顺序:使用指南紧跟快速开始,提升阅读流畅度 - 新增规则集目录表格,展示 40+ 技术领域分类 - 合并「项目现状」和「维护计划」为一个章节,用表格呈现状态 - 统一章节标题风格,精简冗余内容
1 parent 061d6ce commit 7197a9f

1 file changed

Lines changed: 95 additions & 79 deletions

File tree

README.md

Lines changed: 95 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,31 @@
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

12-
**一个由社区驱动、为中文开发者量身打造的 `Awesome Cursor Rules` 高质量翻译和优化项目。目前已完成所有规则集的翻译工作**
12+
**一个由社区驱动、为中文开发者量身打造的 [Cursor](https://cursor.sh/) AI 编程规则集合**
1313

14-
本项目的目标不仅是翻译,更是对原项目进行结构优化和内容增强,使其更符合中文开发者的使用习惯。
14+
**所有规则集已完成高质量翻译,涵盖 40+ 技术领域、450+ 规则文件。**
1515

16-
[🚀 快速开始](#-快速开始) [🌟 项目亮点](#-项目亮点)[🗺️ 路线图](#-项目路线图) [🤝 参与贡献](#-参与贡献)
16+
[🚀 快速开始](#-快速开始) · [📂 规则集目录](#-规则集目录) · [💡 使用指南](#-使用指南与最佳实践) · [🤝 参与贡献](#-参与贡献)
1717

1818
</div>
1919

2020
---
2121

2222
## 🤔 这是什么?
2323

24-
`Awesome Cursor Rules` 是一个优秀的 [Cursor](https://cursor.sh/) AI 编程助手规则集合,但原项目主要面向英文用户。本项目致力于:
24+
[Awesome Cursor Rules](https://github.com/PatrickJS/awesome-cursorrules) 是一个优秀的 Cursor AI 编程助手规则集合,但原项目主要面向英文用户。本项目致力于:
2525

26-
1. **精准翻译**: 提供高质量的中文翻译,消除语言障碍。
27-
2. **结构优化**: 按照 `后端/前端/数据库/AI` 等技术领域优化目录结构,方便查找
28-
3. **内容增强**: 补充更符合国内技术生态的规则和最佳实践。
26+
1. **精准翻译** 提供高质量的中文翻译,消除语言障碍。
27+
2. **结构优化** — 按技术领域重新组织目录结构,方便快速查找
28+
3. **内容增强** 补充更符合国内技术生态的规则和最佳实践。
2929

3030
## 🌟 项目亮点
3131

32-
- **🎯 专为中文优化**: 所有规则都经过精心翻译和本地化,术语准确,符合中文语境。
33-
- **🗂️ 清晰的结构**: 按技术领域重新组织,一目了然
34-
- **✅ 开箱即用**: 只需将 `.cursorrules` 文件复制到项目根目录即可生效。
35-
- **📈 社区驱动**: 欢迎任何人参与贡献,共同打造最好的中文规则库。
36-
- **📝 完善的文档**: 提供详尽的《入门指南》、《贡献指南》和《行为准则》
32+
- **🎯 专为中文优化** — 所有规则经过精心翻译和本地化,术语准确,符合中文语境。
33+
- **🗂️ 清晰的结构** — 按技术领域分类,覆盖前端、后端、AI、DevOps 等 40+ 方向
34+
- **✅ 开箱即用** — 将 `.cursorrules` 文件复制到项目根目录即可生效。
35+
- **📈 社区驱动** 欢迎任何人参与贡献,共同打造最好的中文规则库。
36+
- **🛡️ 质量保障** — 自动化校验脚本 + 术语一致性检查 + 严格的 PR 审核流程
3737

3838
## 🚀 快速开始
3939

@@ -46,116 +46,132 @@ cd awesome-cursorrules-zh
4646

4747
### 2. 浏览并选择规则
4848

49-
我们提供了覆盖多种技术栈的规则集,目录结构如下:
49+
根据你的项目技术栈,进入 [`rules/`](./rules/) 目录找到最适合的规则集。
5050

51+
```bash
52+
# 示例:查看 React 相关规则
53+
ls rules/frontend/react/
5154
```
52-
rules/
53-
├── backend/ # 后端技术栈 (Node.js, Python, Go, ...)
54-
├── frontend/ # 前端技术栈 (React, Vue, Angular, ...)
55-
├── mobile/ # 移动端开发 (React Native, Flutter, ...)
56-
├── database/ # 数据库相关
57-
├── ai/ # 人工智能与机器学习
58-
└── general/ # 通用规则
59-
```
60-
61-
根据你的项目需求,进入相应目录找到最适合的规则。
6255

6356
### 3. 复制规则到你的项目
6457

65-
将选定的 `.cursorrules` 文件复制到你项目的根目录。
66-
6758
```bash
6859
# 示例:为 Next.js + TypeScript 项目复制规则
6960
cp rules/frontend/react/nextjs-typescript/.cursorrules /path/to/your/project/
7061
```
7162

7263
### 4. 在 Cursor 中享受智能编码
7364

74-
用 Cursor 打开你的项目,它将自动加载 `.cursorrules` 文件。现在,你可以在 AI 辅助下进行高效、规范的编码了
65+
用 Cursor 打开你的项目,它将自动加载 `.cursorrules` 文件,即刻享受 AI 辅助的高效编码体验
7566

76-
## 🗺️ 项目维护与未来计划
67+
## 📂 规则集目录
7768

78-
随着所有规则集的翻译工作顺利完成,项目现已进入持续维护和优化阶段。我们欢迎您参与进来,共同确保规则集的质量与时俱进。
69+
我们提供了覆盖 **40+ 技术领域** 的规则集:
7970

80-
未来的工作重点包括:
81-
- **同步上游更新**:定期与 [原项目](https://github.com/PatrickJS/awesome-cursorrules) 保持同步,引入新的规则。
82-
- **质量优化**:根据社区反馈,持续改进翻译质量和规则的实用性。
83-
- **文档完善**:优化使用指南和项目文档,提升用户体验。
71+
| 领域 | 目录 | 说明 |
72+
|------|------|------|
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 约定 等 |
8484

85-
## 📊 项目现状
86-
- **翻译进度**: 100% 完成
87-
- **质量状态**: 高质量翻译,已审核
88-
- **最新版本**: v1.5.0
89-
- **查看详细进度**[翻译进度报告](./docs/translation-progress.md)
85+
> 📋 完整目录请浏览 [`rules/`](./rules/) 文件夹,还包括 `cloud/``gaming/``quantum/``robotics/``hardware/` 等更多领域。
9086
91-
## 🤝 参与贡献
92-
我们热烈欢迎各种形式的贡献!现在项目进入维护阶段,您可以通过以下方式参与:
93-
- **报告问题**:发现翻译不准确或规则已过时,请通过 [Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 告诉我们。
94-
- **改进翻译**:提交 Pull Request 帮助我们优化现有内容。
95-
- **同步上游**:帮助项目与 [原版 awesome-cursorrules](https://github.com/PatrickJS/awesome-cursorrules) 保持同步。
87+
## 💡 使用指南与最佳实践
9688

97-
在开始之前,请阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](./CONTRIBUTING.md),它详细说明了如何参与项目维护。
89+
### 如何选择规则?
9890

99-
## ✨ 行为准则
91+
- **新项目** — 选择对应技术栈的**完整规则集**,从一开始就建立高标准。例如,使用 `nextjs-typescript` 而不是 `react-basic`
92+
- **现有项目** — 从 `general/code-guidelines` 这类**通用规则**开始,逐步引入更具体的规则。
10093

101-
为了营造一个开放和友好的社区环境,我们期望所有参与者都能遵守 [**行为准则 (CODE_OF_CONDUCT.md)**](./CODE_OF_CONDUCT.md)
94+
### 如何处理多技术栈项目?
10295

103-
## 📄 许可证
96+
**方法 1:合并规则文件**
10497

105-
本项目采用 [MIT 许可证](./LICENSE)授权。
98+
```bash
99+
# 将 React 和 FastAPI 的规则合并为一个文件
100+
cat rules/frontend/react/react-best-practices/.cursorrules > /path/to/your/project/.cursorrules
101+
echo "" >> /path/to/your/project/.cursorrules
102+
cat rules/backend/python/fastapi-best-practices/.cursorrules >> /path/to/your/project/.cursorrules
103+
```
106104

107-
## 🛡️ 质量保障
108-
- 自动化校验脚本确保翻译一致性
109-
- 专业术语词典统一技术词汇
110-
- 严格的PR审核流程
105+
**方法 2:使用目录特定规则**
111106

112-
## 💡 使用指南与最佳实践
107+
在项目根目录放置通用规则,在子目录中放置特定规则。Cursor 会优先使用更深层级的规则。
113108

114-
### 如何选择规则?
109+
```
110+
your-project/
111+
├── .cursorrules # 通用规则
112+
├── frontend/
113+
│ └── .cursorrules # 前端特定规则
114+
└── backend/
115+
└── .cursorrules # 后端特定规则
116+
```
115117

116-
- **新项目**:建议选择对应技术栈的**完整规则集**,从一开始就建立高标准。例如,使用 `nextjs-typescript` 而不是 `react-basic`
117-
- **现有项目**:可以从 `general/code-guidelines` 这类**通用规则**开始,逐步引入更具体的规则,以避免对现有代码库产生过多干扰。
118+
### 如何与团队协作?
118119

119-
### 如何处理多技术栈项目?
120+
1. **版本控制** — 将 `.cursorrules` 提交到 Git,确保团队使用统一规范。
121+
2. **文档说明** — 在项目 README 中注明规则来源,方便新成员了解。
120122

121-
对于包含前后端的全栈项目,你有两种选择:
123+
### 如何自定义规则?
122124

123-
1. **合并规则文件**:将前端和后端的规则集合并成一个 `.cursorrules` 文件放在项目根目录。
124-
```bash
125-
# 示例:合并 React 和 FastAPI 的规则
126-
cat rules/frontend/react/react-best-practices/.cursorrules > /path/to/your/project/.cursorrules
127-
echo "" >> /path/to/your/project/.cursorrules
128-
cat rules/backend/python/fastapi-best-practices/.cursorrules >> /path/to/your/project/.cursorrules
129-
```
130-
2. **使用目录特定规则**:在项目根目录放置通用规则,在 `frontend/``backend/` 等子目录中分别放置特定规则。Cursor 会优先使用更深层级的规则。
125+
直接编辑 `.cursorrules` 文件,在末尾添加团队或项目特有的规则:
131126

132-
### 如何与团队协作?
127+
```
128+
- 使用团队约定的 API 命名法
129+
- 所有数据库模型必须包含 created_at 和 updated_at 字段
130+
```
133131

134-
1. **版本控制**:将 `.cursorrules` 文件提交到 Git 仓库中,确保团队成员使用统一的编码规范。
135-
```bash
136-
git add .cursorrules
137-
git commit -m "feat: add cursor ai coding standards"
138-
```
139-
2. **文档说明**:在团队的 `README.md` 中简要说明,提醒新成员安装 Cursor 并遵循规则。
132+
> 📖 更多详细用法请查阅 [快速开始指南](./docs/getting-started.md)[最佳实践](./docs/best-practices.md)
140133
141-
### 如何自定义规则?
134+
## 📊 项目现状与未来计划
142135

143-
直接编辑项目根目录的 `.cursorrules` 文件,在文件末尾添加你的团队或项目特有的规则,例如:
144-
- `使用团队约定的 API 命名法`
145-
- `所有数据库模型必须包含 created_at 和 updated_at 字段`
136+
| 指标 | 状态 |
137+
|------|------|
138+
| **翻译进度** | ✅ 100% 完成 |
139+
| **质量状态** | ✅ 高质量翻译,已审核 |
140+
| **最新版本** | v1.5.0 |
141+
| **详细报告** | [翻译进度报告](./docs/translation-progress.md) |
146142

147-
---
143+
项目已进入**持续维护和优化阶段**,未来工作重点:
144+
145+
- **同步上游更新** — 定期与 [原项目](https://github.com/PatrickJS/awesome-cursorrules) 保持同步,引入新规则。
146+
- **质量优化** — 根据社区反馈,持续改进翻译质量和规则的实用性。
147+
- **文档完善** — 优化使用指南和项目文档,提升用户体验。
148+
149+
## 🤝 参与贡献
150+
151+
我们欢迎各种形式的贡献!
152+
153+
- **🐛 报告问题** — 发现翻译不准确或规则已过时?请通过 [Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 告诉我们。
154+
- **🔧 改进翻译** — 提交 Pull Request 帮助优化现有内容。
155+
- **🔄 同步上游** — 帮助项目与 [原版](https://github.com/PatrickJS/awesome-cursorrules) 保持同步。
156+
157+
在开始之前,请阅读 [**贡献指南**](./CONTRIBUTING.md)[**行为准则**](./CODE_OF_CONDUCT.md)
148158

149159
## 🐛 遇到问题?
150160

151-
如果规则不生效或遇到其他问题,请查阅我们的 [**故障排除指南 (docs/troubleshooting.md)**](./docs/troubleshooting.md),里面包含了常见问题的解决方案和诊断工具
161+
请查阅 [**故障排除指南**](./docs/troubleshooting.md)里面包含常见问题的解决方案和诊断工具
152162

153-
## 致谢
163+
## 🙏 致谢
154164

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

157167
感谢所有为本项目贡献翻译和改进的开发者们!
158168

169+
## 📄 许可证
170+
171+
本项目采用 [MIT 许可证](./LICENSE) 授权。
172+
173+
---
174+
159175
<div align="center">
160176

161177
**如果这个项目对你有帮助,请给我们一个 ⭐**

0 commit comments

Comments
 (0)