Skip to content

Commit e9f2cd9

Browse files
author
shijiashuai
committed
docs: optimize README with correct usage guide and contribution standards
- Fix outdated Cursor rule import instructions with two correct methods - Add file mapping column to tech stack table - Add rule file format explanation (frontmatter and globs) - Add new rule contribution template
1 parent 854a388 commit e9f2cd9

1 file changed

Lines changed: 51 additions & 15 deletions

File tree

README.md

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,44 @@
2323

2424
我们目前支持以下语言和框架的规则集:
2525

26-
| 分类 | 技术栈 |
27-
| :--- | :--- |
28-
| **编程语言** | `Python`, `Java`, `Go`, `C#`, `Ruby`, `PHP`, `C++`, `TypeScript` |
29-
| **后端框架** | `Node.js/Express`, `Spring`, `FastAPI`, `.NET`, `Ruby on Rails` |
30-
| **前端** | `React`, `Vue`, `Svelte`, `Next.js`, `Tailwind CSS`, `Medusa` |
31-
| **移动端** | `Android`, `iOS`, `WeChat Mini Program`, `NativeScript` |
32-
| **数据库** | `Database` (通用) |
33-
| **DevOps** | `Docker` |
34-
| **通用规范** | `Clean Code`, `Code Quality`, `Git Flow` |
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` |
3535

3636
## 🚀 使用指南
3737

38-
在 Cursor 编辑器中,您可以轻松地导入和使用这些规则。
38+
### 方式一:直接复制到项目(推荐)
3939

40-
1. 打开 Cursor 编辑器。
41-
2. 按下 `Ctrl + K` (Windows/Linux) 或 `Cmd + K` (macOS),然后输入 `@rules`
42-
3. 选择“导入规则”。
43-
4. 将您需要的 `.mdc` 文件的内容复制并粘贴到输入框中。
40+
1. 在您的项目根目录下创建 `.cursor/rules/` 目录。
41+
2. 将您需要的 `.mdc` 文件复制到该目录中。
42+
3. Cursor 会自动识别并应用这些规则。
4443

45-
例如,要导入 Python 规则,只需将 `python.mdc` 文件的内容粘贴进去即可。
44+
```bash
45+
# 示例:将 Python 和 Clean Code 规则复制到项目中
46+
mkdir -p .cursor/rules
47+
cp python.mdc clean-code.mdc .cursor/rules/
48+
```
49+
50+
### 方式二:通过 Cursor 设置导入
51+
52+
1. 打开 Cursor 编辑器。
53+
2. 进入 `Settings` > `Cursor Settings` > `Rules`
54+
3. 点击 `Add Rule`,将 `.mdc` 文件的内容粘贴到规则编辑器中。
55+
56+
### 规则文件说明
57+
58+
每个 `.mdc` 文件包含两部分:
59+
60+
- **Frontmatter**`---` 之间的内容):定义规则的描述和适用的文件类型(`globs`)。
61+
- **规则正文**:具体的编码规范和最佳实践指南。
62+
63+
`globs` 不为空时,规则仅在匹配的文件类型上生效;当 `globs` 为空时,规则作为通用规范全局生效。
4664

4765
## 📜 许可证
4866

@@ -60,6 +78,24 @@
6078
4. 推送到分支 (`git push origin feature/AmazingFeature`)。
6179
5. 打开一个 Pull Request。
6280

81+
### 编写新规则的规范
82+
83+
如果您想贡献新的规则文件,请遵循以下格式:
84+
85+
```markdown
86+
---
87+
description: 简短描述该规则集的用途
88+
globs: **/*.ext, src/**/*.ext
89+
---
90+
91+
# 技术名称 最佳实践
92+
93+
## 章节标题
94+
- 具体、可操作的指导(避免空泛的描述)
95+
- 推荐具体的工具、库和命令
96+
- 提供代码示例和配置参考
97+
```
98+
6399
## ❤️ 致谢
64100

65101
感谢所有为这个项目做出贡献的开发者!

0 commit comments

Comments
 (0)