Cline rules - Cline

TL;DR

Cline Rules为Cline提供项目级指导，通过.clinerules/目录或UI界面管理，支持版本控制和团队一致性。规则以Markdown格式存储，可定制项目特定标准和实践。规则库（clinerules-bank/）用于多上下文项目，方便切换和管理。Toggleable Popover UI简化了规则的查看、切换和管理。

Summary

好的，这是对您提供的关于 Cline Rules 的文档的 Markdown 列表格式总结：

  1. Cline Rules定义：为 Cline 提供系统级指导，可视为项目或全局的上下文和偏好设置的持久化方式。

  2. 创建规则：
    • 通过 Rules 选项卡的 + 按钮。
    • 通过 IDE 创建并保存文件：
      • 工作区规则：存储在项目中的 .clinerules/ 目录中。
      • 全局规则：存储在 Documents/Cline/Rules 目录中。
    • 使用聊天中的 /newrule 斜杠命令。
  3. 规则结构示例：
    • 包含项目指导、文档要求、架构决策记录、代码风格与模式、测试标准等部分。
    • 利用 Markdown 格式，结构清晰。
  4. 关键优势：
    • 版本控制：.clinerules 文件是项目源代码的一部分。
    • 团队一致性：确保所有团队成员的行为一致。
    • 项目特定：规则和标准针对每个项目的需求量身定制。
    • 机构知识：在代码中维护项目标准和实践。
  5. .clinerules 位置：
    • 放置在项目的根目录中，与 src/、docs/ 等目录同级。
  6. 系统提示：
    • Cline 的系统提示不可编辑，可在 GitHub 上查看。
    • 建议参考 prompt engineering 的最佳实践。
  7. 编写技巧：
    • 清晰简洁，避免歧义。
    • 关注期望的结果，而非具体的步骤。
    • 测试和迭代，找到最适合工作流程的方式。
  8. .clinerules/ 目录结构：
    • 包含多个 Markdown 文件，每个文件代表一个规则。
    • 数字前缀（可选）用于组织文件的顺序。
    • Cline 自动处理 .clinerules/ 目录中的所有 Markdown 文件，将它们合并为一个统一的规则集。
  9. 规则库（Rules Bank）：
    • 用于具有多个上下文或团队的项目。
    • clinerules-bank/ 目录用于存储可用但未激活的规则。
    • 可以按照客户、框架、项目类型等进行分类。
  10. 文件夹方式的优势：
    • 上下文激活：仅从规则库复制相关的规则到激活的文件夹。
    • 易于维护：更新单个规则文件不会影响其他文件。
    • 团队灵活性：不同的团队成员可以激活特定于其当前任务的规则。
    • 减少干扰：保持激活的规则集集中且相关。
  11. 使用案例：
    • 切换客户端项目时，替换相应的客户端规则文件。
    • 适应不同的技术栈时，添加相应的框架规则文件。
  12. 实现技巧：
    • 单个规则文件应专注于特定问题。
    • 使用描述性的文件名来清楚地表明规则的目的。
    • 考虑 git 忽略激活的 .clinerules/ 文件夹，同时跟踪 clinerules-bank/。
    • 创建团队脚本以快速激活常用的规则组合。
  13. Toggleable Popover UI （Cline v3.13引入）：
    • 位置：位于聊天输入框下方。
    • 功能：
      • 查看激活规则：查看当前激活的全局规则和工作区规则。
      • 快速切换规则：一键启用或禁用工作区 .clinerules/ 文件夹中的规则文件。
      • 添加/管理规则：快速创建工作区 .clinerules 文件或文件夹，或向现有文件夹添加新的规则文件。
  14. 总结：Cline Rules 提供了一种动态的知识系统，可以通过文件或文件夹进行组织和管理，适应团队不断变化的上下文和需求，并通过 UI 界面简化管理。