Skip to content

快速开始

Cursor Rules 是一个精心策划的 .mdc 规则库,包含 24 个高质量规则,帮助 AI 编码助手提供更精准、更符合最佳实践的代码建议。

🚀 5 分钟快速上手

1. 选择规则

浏览我们的 规则分类,找到适合您项目技术栈的规则。

2. 下载规则

点击规则文件或直接从 GitHub 仓库下载:

bash
# 克隆仓库
git clone https://github.com/LessUp/cursor-rules.git

# 进入目录
cd cursor-rules

3. 添加到项目

把选中的 .mdc 文件复制到目标项目的 Cursor 规则目录。推荐保留多个规则文件,方便按技术栈组合和审查。

bash
mkdir -p /path/to/your/project/.cursor/rules
cp react.mdc typescript.mdc tailwind.mdc /path/to/your/project/.cursor/rules/

不要把所有规则强行合并成一个文件。组合使用能保留每条规则的边界和适用范围。

4. 开始编码

现在您的 AI 编码助手会使用这些规则提供更精准的建议!

📁 支持的规则文件

规则文件技术栈描述
react.mdcReactReact 应用开发最佳实践
vue.mdcVue.jsVue.js 开发规范
typescript.mdcTypeScriptTypeScript 最佳实践
python.mdcPythonPython 开发规范
go.mdcGoGo 语言开发指南
docker.mdcDocker容器化开发规范
.........

查看 完整规则列表 了解所有可用规则。

⚙️ 配置 AI 工具

Cursor

  1. 打开 Cursor 设置
  2. 确保启用了 "Rules" 功能
  3. .mdc 文件放在项目根目录
  4. Cursor 会自动加载和应用规则

其他 AI 工具

虽然这些规则主要为 Cursor 设计,但也可以:

  • 作为参考文档指导代码审查
  • 提供给其他 AI 工具作为上下文
  • 用于团队代码规范培训

🔧 自定义规则

您可以根据项目需求修改规则文件:

markdown
---
description: 适用于我们项目的 React 最佳实践
globs: **/*.tsx, **/*.jsx, components/**/*
---

# React 最佳实践

## 组件结构
- 使用函数组件而非类组件
- 保持组件小而专注
- [添加您的自定义规则...]

规则文件结构

每个 .mdc 文件包含:

  • Frontmatter: 元数据(描述、文件匹配模式等)
  • 规则内容: 具体的编码规范和最佳实践
  • 分类标签: 帮助 AI 理解规则的应用场景

🎯 最佳实践

1. 选择合适的规则

  • 根据项目技术栈选择对应规则
  • 可以组合多个规则文件
  • 定期更新规则以获得最新改进

2. 团队协作

  • 将规则文件纳入版本控制
  • 在团队中统一规则使用
  • 定期审查和优化规则内容

3. 持续改进

  • 根据项目需求自定义规则
  • 收集团队反馈优化规则
  • 关注上游仓库的更新

🛠️ 故障排除

规则不生效?

  1. 确认文件名是 .mdc 格式
  2. 检查文件是否在项目根目录
  3. 验证 AI 工具的规则功能是否启用
  4. 尝试重启 AI 工具

规则冲突?

  1. 检查是否有多个规则文件存在冲突
  2. 合并相关规则到一个文件
  3. 根据优先级调整规则顺序

📚 进阶使用

组合规则

对于复杂项目,您可以:

bash
# 组合前端规则
cat react.mdc typescript.mdc tailwind.mdc > frontend.mdc
mv frontend.mdc .mdc

条件规则

使用 glob 模式精确控制规则应用:

yaml
---
globs: 
  - "**/*.tsx"
  - "**/*.jsx"
  - "components/**/*"
  - "!**/*.test.*"
---

🤝 贡献指南

欢迎贡献您的规则和改进!

  1. Fork 项目仓库
  2. 创建功能分支
  3. 添加或改进规则
  4. 提交 Pull Request

查看 贡献指南 了解详细信息。


🎉 开始您的 AI 编码之旅

现在您已经了解了如何使用 Cursor Rules,开始探索我们的 规则库,提升您的 AI 编码体验吧!

26 curated .mdc rules for better AI coding assistance.