Skip to content

Commit 6896d6d

Browse files
committed
📝 docs(rules): 完成全部rules文档的翻译
1 parent 0383267 commit 6896d6d

26 files changed

+119
-2328
lines changed

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)
66
并且本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)
77

8+
## [1.5.0] - 2025-07-03
9+
10+
### 新增
11+
- **完成所有规则集翻译**:项目翻译进度达到 100%。
12+
- **文档全面优化**:统一更新 `README.md`, `CONTRIBUTING.md`, 和 `CODE_OF_CONDUCT.md` 以反映项目进入维护阶段。
13+
814
## [1.4.0] - 2025-07-02
915

1016
### 新增
@@ -163,10 +169,4 @@
163169

164170
---
165171

166-
## 计划中的更新
167172

168-
### [1.2.0] - 计划中
169-
- 新增 Angular 框架规则集
170-
- 新增 Flutter/Dart 规则集
171-
- 新增 PHP Laravel 规则集
172-
- 社区贡献工具优化

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributor Covenant Code of Conduct
1+
# 贡献者契约行为准则
22

3-
## Our Pledge
3+
## 我们的承诺
44

55
We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
@@ -58,9 +58,8 @@ representative at an online or offline event.
5858

5959
## Enforcement
6060

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
[INSERT CONTACT METHOD].
61+
如果遇到骚扰、滥用或其他不可接受的行为,请通过
62+
**[在此处插入项目维护者的联系方式]** 向负责执行准则的社区负责人报告。
6463
All complaints will be reviewed and investigated promptly and fairly.
6564

6665
All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

Lines changed: 24 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 贡献指南
22

3-
感谢您对 Awesome Cursor Rules 中文版的关注!我们欢迎所有形式的贡献。本项目采用标准化的翻译工作流程,确保高质量的翻译成果。
3+
# 贡献指南
4+
5+
感谢您对 Awesome Cursor Rules 中文版的关注!随着项目所有翻译工作的完成,我们现在进入了持续维护和优化阶段。我们欢迎所有形式的贡献,共同保持这个项目的活力。
46

57
## 🚀 快速开始
68

@@ -17,65 +19,32 @@
1719
- 文本编辑器(推荐 VS Code 或 Cursor)
1820
- 基本的 Markdown 知识
1921

20-
## 🔄 标准化翻译工作流程
21-
22-
我们建立了完整的6阶段翻译工作流程,确保翻译质量和效率:
23-
24-
### 阶段1:翻译准备
25-
- 选择目标规则集(参考优先级列表)
26-
- 检查原始文件完整性
27-
- 准备翻译环境和工具
28-
- 规划目录结构
29-
30-
### 阶段2:翻译执行
31-
- **第一遍翻译**:使用 AI 辅助进行整体翻译
32-
- **第二遍优化**:改进中文表达的自然性
33-
- **第三遍校对**:完善细节和格式
34-
35-
### 阶段3:自检验证
36-
- 术语一致性检查
37-
- 结构完整性检查
38-
- 内容准确性检查
39-
- 语言质量检查
40-
41-
### 阶段4:质量审核
42-
- 专业性审核
43-
- 语言审核
44-
- 格式审核
45-
- 最终确认
46-
47-
### 阶段5:发布部署
48-
- 发布前检查
49-
- Git 提交和推送
50-
- 进度更新
5122

52-
### 阶段6:质量跟踪
53-
- 持续监控和改进
5423

5524

5625

5726
## 🤝 贡献方式
5827

59-
### 翻译新的规则集
28+
### 报告问题
29+
如果您发现任何翻译不准确、内容过时或链接失效等问题,请通过 [GitHub Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 提交详细报告。一个好的问题报告应包括:
30+
- 问题所在的具体文件。
31+
- 问题描述。
32+
- (可选)您的修改建议。
33+
34+
### 改进现有翻译
35+
如果您希望直接帮助我们改进内容,请遵循以下步骤:
6036
1. **Fork 本仓库**
61-
2. **创建翻译分支**`git checkout -b translate/规则集名称`
62-
3. **选择目标规则集**:从优先级列表中选择
63-
4. **执行翻译流程**
64-
- 复制原始规则集到对应的中文目录
65-
- 按照翻译标准进行内容翻译
66-
- 进行质量自检和验证
67-
- 提交翻译成果
68-
5. **提交 Pull Request**
37+
2. **创建您的分支**`git checkout -b fix/your-improvement-description`
38+
3. **进行修改**:在您的分支上进行修改。
39+
4. **提交 Pull Request**:提交您的更改,并清晰地描述您所做的改进。
6940

7041
### 改进现有翻译
7142
1. **报告问题**:在 Issues 中详细描述翻译问题
7243
2. **提供改进建议**:包含具体的修改建议
7344
3. **提交 Pull Request**:遵循标准工作流程
7445

75-
### 参与项目管理
76-
1. **流程完善**:改进翻译工作流程
77-
2. **文档维护**:更新项目文档
78-
3. **社区建设**:参与项目讨论和推广
46+
### 同步上游更新
47+
[原项目](https://github.com/PatrickJS/awesome-cursorrules) 可能会有更新。我们欢迎贡献者帮助我们将这些更新同步到中文版中。
7948

8049
## 📝 翻译质量标准
8150

@@ -120,49 +89,23 @@
12089
- **语言审核**:中文表达和术语使用规范性
12190
- **格式审核**:Markdown 格式和链接有效性
12291

123-
## 📋 翻译优先级(2025年更新)
124-
125-
### 🔥 最高优先级(立即开始)
126-
- **Python Django** (`python-django-best-practices-cursorrules-prompt-fi`)
127-
- **Java Spring Boot** (`java-springboot-jpa-cursorrules-prompt-file`)
128-
- **Go 后端开发** (`go-backend-scalability-cursorrules-prompt-file`)
129-
- **Angular TypeScript** (`angular-typescript-cursorrules-prompt-file`)
130-
131-
### ⭐ 高优先级(2-4周内)
132-
- **Flutter 应用开发** (`flutter-app-expert-cursorrules-prompt-file`)
133-
- **Laravel PHP** (`laravel-php-83-cursorrules-prompt-file`)
134-
- **TypeScript NestJS** (`typescript-nestjs-best-practices-cursorrules-promp`)
135-
- **Chrome 扩展开发** (`chrome-extension-dev-js-typescript-cursorrules-pro`)
13692

137-
### 📈 中优先级(4-8周内)
138-
- **Svelte/SvelteKit** (`sveltekit-tailwindcss-typescript-cursorrules-promp`)
139-
- **Astro TypeScript** (`astro-typescript-cursorrules-prompt-file`)
140-
- **SwiftUI** (`swiftui-guidelines-cursorrules-prompt-file`)
141-
- **Android Jetpack Compose** (`android-jetpack-compose-cursorrules-prompt-file`)
142-
143-
### 📚 低优先级(8周后)
144-
- 其他小众技术栈
145-
- 实验性框架
146-
- 特定领域应用
147-
148-
**当前翻译进度**:48/141 规则集 (34.04%)
14993

15094
## 🏷️ 提交规范
15195

15296
使用约定式提交格式:
15397

15498
```bash
155-
# 翻译新规则集
156-
feat(backend/python): add Chinese translation for django best practices
157-
feat(frontend/angular): add Chinese translation for angular typescript
99+
# 示例
100+
101+
# 修复拼写错误
102+
fix(docs): correct spelling in README.md
158103

159-
# 改进现有翻译
160-
fix(backend/java): improve spring boot terminology consistency
161-
docs(frontend/react): update react hooks translation
104+
# 更新某个规则集
105+
feat(backend/python): sync django best practices with upstream
162106

163-
# 项目管理
164-
docs: update project documentation
165-
refactor: improve project structure
107+
# 改进文档
108+
docs: update contributing guide for maintenance phase
166109
```
167110

168111
### 提交信息模板
@@ -201,12 +144,7 @@ refactor: improve project structure
201144
- **Pull Request**:提交代码和翻译
202145
- **Discussions**:参与项目讨论
203146

204-
## 维护阶段贡献指南
205147

206-
本项目翻译已全部完成,欢迎参与维护工作:
207-
- 报告问题
208-
- 提交改进建议
209-
- 帮助同步上游更新
210148

211149
---
212150

README.md

Lines changed: 85 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
<div align="center">
44

5-
[![项目状态](https://img.shields.io/badge/status-translating-yellow?style=for-the-badge)](https://github.com/LessUp/awesome-cursorrules-zh)
6-
[![翻译进度](https://img.shields.io/badge/progress-92.6%25-brightgreen?style=for-the-badge)](./docs/translation-progress.md)
5+
[![项目状态](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)
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

12-
**一个由社区驱动、为中文开发者量身打造的 `Awesome Cursor Rules` 高质量翻译和优化项目。目前已完成 `92.6%` 的翻译工作**
12+
**一个由社区驱动、为中文开发者量身打造的 `Awesome Cursor Rules` 高质量翻译和优化项目。目前已完成所有规则集的翻译工作**
1313

1414
本项目的目标不仅是翻译,更是对原项目进行结构优化和内容增强,使其更符合中文开发者的使用习惯。
1515

@@ -37,36 +37,64 @@
3737

3838
## 🚀 快速开始
3939

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+
```
4560

46-
2. **找到并复制规则**
47-
浏览 `rules` 目录,找到你需要的规则集(例如 `rules/frontend/react/`),然后将其中的 `.cursorrules` 文件和相关 `.mdc` 文件复制到你的项目根目录。
61+
根据你的项目需求,进入相应目录找到最适合的规则。
4862

49-
3. **在 Cursor 中享受智能编码**
50-
打开你的项目,Cursor 将自动加载规则,开始享受为中文优化的 AI 编程体验!
63+
### 3. 复制规则到你的项目
5164

52-
## 🗺️ 项目路线图与未来计划
65+
将选定的 `.cursorrules` 文件复制到你项目的根目录。
5366

54-
本项目是一个持续发展的开源项目。我们已经完成了第一阶段的核心翻译和结构优化工作,并制定了清晰的未来发展路线图。
67+
```bash
68+
# 示例:为 Next.js + TypeScript 项目复制规则
69+
cp rules/frontend/react/nextjs-typescript/.cursorrules /path/to/your/project/
70+
```
5571

56-
我们诚挚邀请您查看我们的 [**项目待办清单 (PROJECT_TODO.md)**](./PROJECT_TODO.md),在这里您可以了解到我们接下来的翻译目标,并选择您感兴趣的任务参与贡献!
72+
### 4. 在 Cursor 中享受智能编码
5773

58-
## 📊 最新进展(2025年7月)
74+
用 Cursor 打开你的项目,它将自动加载 `.cursorrules` 文件。现在,你可以在 AI 辅助下进行高效、规范的编码了!
75+
76+
## 🗺️ 项目维护与未来计划
77+
78+
随着所有规则集的翻译工作顺利完成,项目现已进入持续维护和优化阶段。我们欢迎您参与进来,共同确保规则集的质量与时俱进。
79+
80+
未来的工作重点包括:
81+
- **同步上游更新**:定期与 [原项目](https://github.com/PatrickJS/awesome-cursorrules) 保持同步,引入新的规则。
82+
- **质量优化**:根据社区反馈,持续改进翻译质量和规则的实用性。
83+
- **文档完善**:优化使用指南和项目文档,提升用户体验。
84+
85+
## 📊 项目现状
5986
- **翻译进度**: 100% 完成
6087
- **质量状态**: 高质量翻译,已审核
61-
- **最新版本**: v1.3.0
88+
- **最新版本**: v1.4.0
6289
- **查看详细进度**[翻译进度报告](./docs/translation-progress.md)
6390

6491
## 🤝 参与贡献
65-
我们热烈欢迎各种形式的贡献!无论是校对翻译、提交新规则、还是改进文档,都对我们至关重要。
92+
我们热烈欢迎各种形式的贡献!现在项目进入维护阶段,您可以通过以下方式参与:
93+
- **报告问题**:发现翻译不准确或规则已过时,请通过 [Issues](https://github.com/LessUp/awesome-cursorrules-zh/issues) 告诉我们。
94+
- **改进翻译**:提交 Pull Request 帮助我们优化现有内容。
95+
- **同步上游**:帮助项目与 [原版 awesome-cursorrules](https://github.com/PatrickJS/awesome-cursorrules) 保持同步。
6696

67-
开始前,请:
68-
1. 查看 [**翻译进度一览**](#-翻译进度一览) 和 [**项目待办清单**](./PROJECT_TODO.md) 寻找未完成的任务。
69-
2. 阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](./CONTRIBUTING.md),它详细说明了如何参与项目。
97+
在开始之前,请阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](./CONTRIBUTING.md),它详细说明了如何参与项目维护。
7098

7199
## ✨ 行为准则
72100

@@ -81,23 +109,46 @@
81109
- 专业术语词典统一技术词汇
82110
- 严格的PR审核流程
83111

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

86-
### 使用技巧
119+
### 如何处理多技术栈项目?
87120

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+
---
92148

93-
**⚡ 最佳实践**
94-
- 每个项目使用一个主要的 `.cursorrules` 文件
95-
- 定期关注项目更新,获取最新规则集
96-
- 根据团队需求适当调整规则内容
149+
## 🐛 遇到问题?
97150

98-
**📚 更多资源**
99-
- [📋 贡献指南](./CONTRIBUTING.md) - 了解如何参与翻译
100-
- [📝 更新日志](./CHANGELOG.md) - 查看版本更新记录
151+
如果规则不生效或遇到其他问题,请查阅我们的 [**故障排除指南 (docs/troubleshooting.md)**](./docs/troubleshooting.md),里面包含了常见问题的解决方案和诊断工具。
101152

102153
## 参与贡献
103154

0 commit comments

Comments
 (0)