贡献指南

April 17, 2026 · View on GitHub

感谢你对 Awesome Cursor Rules 中文版的关注！本项目欢迎所有形式的贡献。

目录

行为准则

参与本项目即表示你同意遵守我们的 行为准则。

核心原则：

  • 尊重所有贡献者
  • 接受建设性批评
  • 关注对社区最有利的事情

如何贡献

报告问题

发现翻译错误或内容过时？请提交 Issue：

  1. 搜索 现有 Issues 确保问题未被报告
  2. 使用问题模板创建新 Issue
  3. 提供清晰的描述和复现步骤

改进内容

# 1. Fork 仓库
gh repo fork LessUp/awesome-cursorrules-zh

# 2. 克隆你的 Fork
git clone https://github.com/你的用户名/awesome-cursorrules-zh.git
cd awesome-cursorrules-zh

# 3. 创建分支
git checkout -b fix/your-improvement

# 4. 进行修改
# 编辑相关文件

# 5. 提交更改
git add .
git commit -m "fix: 修复翻译错误"

# 6. 推送到 Fork
git push origin fix/your-improvement

# 7. 创建 Pull Request
gh pr create

同步上游更新

# 添加上游仓库
git remote add upstream https://github.com/LessUp/awesome-cursorrules-zh.git

# 获取最新更新
git fetch upstream

# 合并到本地
git checkout main
git merge upstream/main

规范驱动开发 (SDD)

本项目遵循**规范驱动开发（Spec-Driven Development）**范式。所有新增功能、规则或变更都必须以 /specs 目录下的规范文档为依据。

贡献规则

  1. 先更新规范，再实现变更

    • 新增规则集或功能前，先查阅 /specs/product/ 中的产品需求文档
    • 技术实现前，先查看 /specs/rfc/ 中的技术设计文档
    • API 相关变更，先更新 /specs/api/ 中的接口定义

  2. AI 助手工作流

    • 本项目使用 AGENTS.md 定义 AI 助手工作流
    • AI 助手必须遵循"先看规范，再写代码"的原则
    • 详见 AGENTS.md

  3. 贡献流程

    提出想法 → 更新/创建 Spec → 社区审核 → 实现代码 → 合并

如何为规范做贡献

  • 📝 在 /specs/product/ 中提交新功能建议
  • 🏗️ 在 /specs/rfc/ 中编写技术设计方案
  • 🔌 在 /specs/api/ 中更新接口定义

翻译规范

术语一致性

英文中文翻译说明
Component组件
Hook钩子React 术语
State状态
Props属性或保留 props
Middleware中间件
Endpoint端点
Repository仓库Git 语境
Repository仓储DDD 语境
Schema模式数据库语境
Schema架构GraphQL 语境

专有名词保留英文：

  • React, Vue, Angular, Svelte
  • Next.js, Nuxt, NestJS
  • TypeScript, JavaScript
  • Docker, Kubernetes
  • PostgreSQL, MongoDB
  • FastAPI, Django

翻译质量标准

维度要求权重
准确性术语翻译准确，技术概念无误40%
流畅性中文表达自然，符合技术文档习惯30%
完整性内容完整，无遗漏20%
规范性格式正确，术语使用规范10%

翻译检查清单

  • 专有名词保留英文
  • 技术术语翻译一致
  • 代码示例未被修改
  • Markdown 格式正确
  • 链接有效可访问
  • 无语法和拼写错误

提交规范

使用约定式提交格式：

<类型>(<范围>): <描述>

[可选正文]

[可选页脚]

提交类型

类型说明示例
feat新功能feat: 添加 Go 后端规则集
fixBug 修复fix: 修正 FastAPI 规则中的错误
docs文档更新docs: 更新安装指南
translate翻译更新translate: 完成 React 规则集翻译
refactor重构refactor: 重组目录结构
style格式调整style: 统一缩进格式
test测试相关test: 添加验证脚本
chore杂项chore: 更新 CI 配置

提交示例

# 新增翻译
git commit -m "translate(backend/python): 完成 FastAPI 规则集翻译"

# 修复问题
git commit -m "fix(docs): 修正快速开始指南中的路径错误"

# 更新文档
git commit -m "docs: 更新贡献指南中的提交规范"

审核流程

Pull Request 流程

提交 PR → 自动检查 → 人工审核 → 合并
    │         │           │        │
    │         │           │        └── 完成贡献
    │         │           └── 代码审查
    │         └── CI/CD 检查
    └── 创建 PR

审核标准

检查项要求
CI 检查全部通过
代码质量无明显问题
翻译质量符合翻译规范
提交信息符合提交规范
文档完整必要的文档已更新

审核时间

  • 小型修复：1-3 天
  • 中型变更：3-7 天
  • 大型变更：7-14 天

贡献者认可

贡献等级

等级条件标识
🥉 翻译贡献者完成 1-3 个规则集列入贡献者名单
🥈 活跃贡献者完成 4-10 个规则集突出显示
🥇 核心贡献者完成 10+ 规则集或重要功能置顶展示
⭐ 维护者长期参与项目管理协作权限

贡献统计

我们会在项目中记录和展示：

  • 翻译的规则集数量
  • 提交的 PR 数量
  • 参与的领域

获取帮助

感谢你的贡献！ 🙏

每一个翻译、每一次修正，都让中文开发者社区受益。