|
2 | 2 |
|
3 | 3 | <div align="center"> |
4 | 4 |
|
5 | | -[](https://github.com/LessUp/awesome-cursorrules-zh) |
6 | | -[](./docs/translation-progress.md) |
| 5 | +[](https://github.com/LessUp/awesome-cursorrules-zh) |
| 6 | +[](./docs/translation-progress.md) |
7 | 7 | [](https://github.com/LessUp/awesome-cursorrules-zh/stargazers) |
8 | 8 | [](https://github.com/LessUp/awesome-cursorrules-zh/network/members) |
9 | 9 | [](./LICENSE) |
10 | 10 | [](./CONTRIBUTING.md) |
11 | 11 |
|
12 | | -**一个由社区驱动、为中文开发者量身打造的 `Awesome Cursor Rules` 高质量翻译和优化项目。目前已完成 `92.6%` 的翻译工作。** |
| 12 | +**一个由社区驱动、为中文开发者量身打造的 `Awesome Cursor Rules` 高质量翻译和优化项目。目前已完成所有规则集的翻译工作。** |
13 | 13 |
|
14 | 14 | 本项目的目标不仅是翻译,更是对原项目进行结构优化和内容增强,使其更符合中文开发者的使用习惯。 |
15 | 15 |
|
|
37 | 37 |
|
38 | 38 | ## 🚀 快速开始 |
39 | 39 |
|
40 | | -1. **克隆本仓库** |
41 | | - ```bash |
42 | | - git clone https://github.com/LessUp/awesome-cursorrules-zh.git |
43 | | - cd awesome-cursorrules-zh |
44 | | - ``` |
| 40 | +### 1. 克隆本仓库 |
| 41 | + |
| 42 | +```bash |
| 43 | +git clone https://github.com/LessUp/awesome-cursorrules-zh.git |
| 44 | +cd awesome-cursorrules-zh |
| 45 | +``` |
| 46 | + |
| 47 | +### 2. 浏览并选择规则 |
| 48 | + |
| 49 | +我们提供了覆盖多种技术栈的规则集,目录结构如下: |
| 50 | + |
| 51 | +``` |
| 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 | +``` |
45 | 60 |
|
46 | | -2. **找到并复制规则** |
47 | | - 浏览 `rules` 目录,找到你需要的规则集(例如 `rules/frontend/react/`),然后将其中的 `.cursorrules` 文件和相关 `.mdc` 文件复制到你的项目根目录。 |
| 61 | +根据你的项目需求,进入相应目录找到最适合的规则。 |
48 | 62 |
|
49 | | -3. **在 Cursor 中享受智能编码** |
50 | | - 打开你的项目,Cursor 将自动加载规则,开始享受为中文优化的 AI 编程体验! |
| 63 | +### 3. 复制规则到你的项目 |
51 | 64 |
|
52 | | -## 🗺️ 项目路线图与未来计划 |
| 65 | +将选定的 `.cursorrules` 文件复制到你项目的根目录。 |
53 | 66 |
|
54 | | -本项目是一个持续发展的开源项目。我们已经完成了第一阶段的核心翻译和结构优化工作,并制定了清晰的未来发展路线图。 |
| 67 | +```bash |
| 68 | +# 示例:为 Next.js + TypeScript 项目复制规则 |
| 69 | +cp rules/frontend/react/nextjs-typescript/.cursorrules /path/to/your/project/ |
| 70 | +``` |
55 | 71 |
|
56 | | -我们诚挚邀请您查看我们的 [**项目待办清单 (PROJECT_TODO.md)**](./PROJECT_TODO.md),在这里您可以了解到我们接下来的翻译目标,并选择您感兴趣的任务参与贡献! |
| 72 | +### 4. 在 Cursor 中享受智能编码 |
57 | 73 |
|
58 | | -## 📊 最新进展(2025年7月) |
| 74 | +用 Cursor 打开你的项目,它将自动加载 `.cursorrules` 文件。现在,你可以在 AI 辅助下进行高效、规范的编码了! |
| 75 | + |
| 76 | +## 🗺️ 项目维护与未来计划 |
| 77 | + |
| 78 | +随着所有规则集的翻译工作顺利完成,项目现已进入持续维护和优化阶段。我们欢迎您参与进来,共同确保规则集的质量与时俱进。 |
| 79 | + |
| 80 | +未来的工作重点包括: |
| 81 | +- **同步上游更新**:定期与 [原项目](https://github.com/PatrickJS/awesome-cursorrules) 保持同步,引入新的规则。 |
| 82 | +- **质量优化**:根据社区反馈,持续改进翻译质量和规则的实用性。 |
| 83 | +- **文档完善**:优化使用指南和项目文档,提升用户体验。 |
| 84 | + |
| 85 | +## 📊 项目现状 |
59 | 86 | - **翻译进度**: 100% 完成 |
60 | 87 | - **质量状态**: 高质量翻译,已审核 |
61 | | -- **最新版本**: v1.3.0 |
| 88 | +- **最新版本**: v1.4.0 |
62 | 89 | - **查看详细进度**:[翻译进度报告](./docs/translation-progress.md) |
63 | 90 |
|
64 | 91 | ## 🤝 参与贡献 |
65 | | -我们热烈欢迎各种形式的贡献!无论是校对翻译、提交新规则、还是改进文档,都对我们至关重要。 |
| 92 | +我们热烈欢迎各种形式的贡献!现在项目进入维护阶段,您可以通过以下方式参与: |
| 93 | +- **报告问题**:发现翻译不准确或规则已过时,请通过 [Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 告诉我们。 |
| 94 | +- **改进翻译**:提交 Pull Request 帮助我们优化现有内容。 |
| 95 | +- **同步上游**:帮助项目与 [原版 awesome-cursorrules](https://github.com/PatrickJS/awesome-cursorrules) 保持同步。 |
66 | 96 |
|
67 | | -开始前,请: |
68 | | -1. 查看 [**翻译进度一览**](#-翻译进度一览) 和 [**项目待办清单**](./PROJECT_TODO.md) 寻找未完成的任务。 |
69 | | -2. 阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](./CONTRIBUTING.md),它详细说明了如何参与项目。 |
| 97 | +在开始之前,请阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](./CONTRIBUTING.md),它详细说明了如何参与项目维护。 |
70 | 98 |
|
71 | 99 | ## ✨ 行为准则 |
72 | 100 |
|
|
81 | 109 | - 专业术语词典统一技术词汇 |
82 | 110 | - 严格的PR审核流程 |
83 | 111 |
|
84 | | -## 使用指南 |
| 112 | +## 💡 使用指南与最佳实践 |
| 113 | + |
| 114 | +### 如何选择规则? |
| 115 | + |
| 116 | +- **新项目**:建议选择对应技术栈的**完整规则集**,从一开始就建立高标准。例如,使用 `nextjs-typescript` 而不是 `react-basic`。 |
| 117 | +- **现有项目**:可以从 `general/code-guidelines` 这类**通用规则**开始,逐步引入更具体的规则,以避免对现有代码库产生过多干扰。 |
85 | 118 |
|
86 | | -### 使用技巧 |
| 119 | +### 如何处理多技术栈项目? |
87 | 120 |
|
88 | | -**🎯 选择规则集** |
89 | | -- 根据项目技术栈选择对应的规则集 |
90 | | -- 优先选择已翻译的规则集以获得更好的中文体验 |
91 | | -- 可以组合多个相关规则集使用 |
| 121 | +对于包含前后端的全栈项目,你有两种选择: |
| 122 | + |
| 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 会优先使用更深层级的规则。 |
| 131 | + |
| 132 | +### 如何与团队协作? |
| 133 | + |
| 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 并遵循规则。 |
| 140 | + |
| 141 | +### 如何自定义规则? |
| 142 | + |
| 143 | +直接编辑项目根目录的 `.cursorrules` 文件,在文件末尾添加你的团队或项目特有的规则,例如: |
| 144 | +- `使用团队约定的 API 命名法` |
| 145 | +- `所有数据库模型必须包含 created_at 和 updated_at 字段` |
| 146 | + |
| 147 | +--- |
92 | 148 |
|
93 | | -**⚡ 最佳实践** |
94 | | -- 每个项目使用一个主要的 `.cursorrules` 文件 |
95 | | -- 定期关注项目更新,获取最新规则集 |
96 | | -- 根据团队需求适当调整规则内容 |
| 149 | +## 🐛 遇到问题? |
97 | 150 |
|
98 | | -**📚 更多资源** |
99 | | -- [📋 贡献指南](./CONTRIBUTING.md) - 了解如何参与翻译 |
100 | | -- [📝 更新日志](./CHANGELOG.md) - 查看版本更新记录 |
| 151 | +如果规则不生效或遇到其他问题,请查阅我们的 [**故障排除指南 (docs/troubleshooting.md)**](./docs/troubleshooting.md),里面包含了常见问题的解决方案和诊断工具。 |
101 | 152 |
|
102 | 153 | ## 参与贡献 |
103 | 154 |
|
|
0 commit comments