贡献指南

感谢您对 Cursor Rules 项目的关注！我们欢迎各种形式的贡献，包括新规则、改进建议、问题报告等。

🤝 如何贡献

报告问题

发现了问题或有改进建议？请：

1. 检查 已有 Issues
2. 如果问题未被报告，创建新的 Issue
3. 详细描述问题或建议
4. 提供复现步骤（如果是 bug）

提交新规则

我们欢迎高质量的新规则！请确保：

规则质量标准

• 实用性: 解决真实的开发问题
• 清晰性: 规则描述清晰易懂
• 完整性: 覆盖主要使用场景
• 一致性: 与现有规则风格保持一致

规则文件结构

---
description: 简洁描述规则的用途
globs: **/*.ext, specific/path/**/*
---

# 规则标题

## 主要分类
- 具体的规则条目
- 使用简洁的列表格式
- 每个规则条目应该具体可执行

## 另一个分类
- 更多规则条目
- 保持逻辑分组

提交步骤

1. Fork 仓库

   # 在 GitHub 上 Fork 项目
   # 然后克隆您的 Fork
   git clone https://github.com/YOUR_USERNAME/cursor-rules.git
   cd cursor-rules

2. 创建分支

   git checkout -b feature/new-rule-name

3. 添加规则文件

   • 在根目录创建新的 .mdc 文件
   • 文件名使用小写字母和连字符
   • 确保文件格式正确

4. 测试规则

   # 运行验证脚本
   npm run validate
   
   # 构建目录
   npm run build:catalog

5. 提交更改

   git add .
   git commit -m "feat: add [技术栈] rule for [用途]"
   git push origin feature/new-rule-name

6. 创建 Pull Request

   • 在 GitHub 上创建 PR
   • 详细描述规则用途和价值
   • 等待代码审查

改进现有规则

发现现有规则可以改进？

1. 找到对应的 .mdc 文件
2. 创建改进分支
3. 进行修改
4. 测试更改
5. 提交 PR

文档改进

文档也是项目的重要组成部分：

• 改进使用指南
• 添加更多示例
• 修复文档错误
• 翻译文档到其他语言

📝 编码规范

规则文件规范

Frontmatter

---
description: 50 字符内的简洁描述
globs: **/*.ext, specific/path/**/*
---

• description: 简洁描述规则用途
• globs: 文件匹配模式，使用 glob 语法

内容格式

# 规则标题

## 分类名称
- 具体规则条目
- 使用动词开头
- 保持简洁明确
- 一个条目一行

## 另一个分类
- 相关规则条目
- 逻辑分组清晰

命名规范

• 文件名：小写字母 + 连字符 (react-hooks.mdc)
• 规则标题：简洁明确，使用中文
• 分类标题：使用 ## 标题，逻辑分组

代码风格

• 使用 Markdown 格式
• 保持一致的缩进（2 个空格）
• 使用列表而非段落
• 避免过度技术化描述

🧪 测试指南

本地测试

1. 安装依赖

   npm install

2. 验证规则

   npm test

3. 构建文档

   cd docs
   npm run build

4. 预览文档

   cd docs
   npm run dev

规则验证

确保新规则通过所有检查：

• ✅ 语法正确
• ✅ 格式符合规范
• ✅ 文件命名正确
• ✅ Frontmatter 完整
• ✅ 内容清晰有用

📋 Pull Request 模板

PR 标题格式

type(scope): description

类型：

• feat: 新功能
• fix: 修复问题
• docs: 文档更新
• style: 格式调整
• refactor: 重构
• test: 测试相关

示例：

• feat(react): add react hooks best practices
• fix(python): correct typo in description
• docs(readme): update installation guide

PR 描述模板

## 变更类型
- [ ] 新规则
- [ ] 规则改进
- [ ] 文档更新
- [ ] 问题修复

## 变更描述
简要描述这个 PR 的内容和目的。

## 测试
- [ ] 本地测试通过
- [ ] 文档构建成功
- [ ] 规则验证通过

## 检查清单
- [ ] 遵循项目规范
- [ ] 代码风格一致
- [ ] 文档完整
- [ ] 自审查通过

🎯 贡献重点

我们特别欢迎以下贡献：

高优先级

• 🌟 主流技术栈: React、Vue、Python、Go、TypeScript 等
• 🚀 新兴技术: Svelte、Solid.js、Rust 等
• 🔧 开发工具: Docker、Kubernetes、CI/CD 等
• 📱 移动开发: React Native、Flutter 等

中优先级

• 💾 数据库: SQL、NoSQL、ORM 等
• 🌐 Web API: REST、GraphQL、gRPC 等
• 🧪 测试: 单元测试、集成测试、E2E 等
• 📊 监控: 日志、指标、性能分析等

低优先级

• 🏗️ 架构: 微服务、DDD、Clean Architecture 等
• 🔒 安全: 认证、授权、加密等
• 📦 部署: 云服务、容器编排等

🏆 贡献者认可

我们重视每一位贡献者：

贡献类型

• 💻 代码贡献: 新规则、功能改进
• 📖 文档贡献: 文档编写、翻译
• 🐛 问题报告: Bug 发现、建议提出
• 🎨 设计贡献: UI/UX 改进、视觉设计
• 📢 推广贡献: 项目推广、社区建设

认可方式

• 📝 贡献者列表
• 🏆 月度贡献者 highlight
• 📢 社区公告感谢
• 🎁 项目周边奖励

📞 联系方式

有疑问或建议？

• 📧 Email: [项目邮箱]
• 💬 GitHub Issues: [提交问题]
• 🐦 Twitter: [@项目账号]
• 💬 Discord: [社区链接]

📄 许可证

通过贡献代码，您同意您的贡献将在 MIT License 下发布。

---

🎉 开始贡献

准备好贡献了吗？

1. 🌟 Star 项目
2. 🍴 Fork 仓库
3. 🔍 查看 Issues
4. 🚀 开始您的第一个贡献！

感谢您的支持，让我们一起构建更好的 AI 编码规则库！ 🚀

查看 IssuesFork 项目