Meituan CatPaw Rules 设置
什么是 Rules？
Rules 是一种可持久化的规则配置，能够让 AI 助手按照您的团队或个人偏好进行工作。通过 Rules，您可以定制 AI 的行为模式，提升开发效率。
Rules 类型详解
Meituan CatPaw 为您提供了四种灵活的 Rules 配置方式，满足不同场景的使用需求：
| Rules 类型 | 文件路径 | 触发条件 | 使用场景 |
|---|---|---|---|
| 系统级 | .catpaw/rules/{文件名}.md | ruleType: Always 始终生效 |
适用于团队通用的编码规范和基础配置 |
| 智能触发 | .catpaw/rules/{文件名}.md | ruleType: Model Request AI 模型自主判断是否使用 |
适用于特定场景下的智能化处理，如特殊格式要求等 |
| 文件/路径匹配 | .catpaw/rules/{文件名}.md | ruleType: Auto Attached + globs 配置 | 适用于特定文件类型或路径的专门规则 |
| 手动触发 | .catpaw/rules/{文件名}.md | ruleType: Manual 需要手动 @ 调用 |
适用于临时性或特殊用途的规则 |
智能触发 Rules 详细说明
当您设置 ruleType: Model Request 时，Rules 的 name 和 description 会被发送给 AI 模型。模型会根据当前对话内容智能判断是否需要应用该规则，并在需要时获取完整的规则内容来约束 AI 的行为。
文件匹配 Rules 配置示例
对于 ruleType: Auto Attached 类型的 Rules，您需要配置 globs 参数来指定匹配的文件模式：
globs: *.java,*.tsx,src/config/**/*.json
注意：请确保 globs 配置符合标准 glob 语法。例如，当您配置 globs: *.java 时，每当对话中涉及 .java 文件时，对应的规则就会自动传递给 AI 模型。
如何创建 Rules
在 Meituan CatPaw 中创建 Rules 非常简单，只需几个步骤：
- 启动 Rules 创建：在对话框中输入
@符号，然后选择 "Rules"。 - 添加新规则：选择 "添加新 Rule"，在弹出的界面中输入您的规则名称。
- 配置规则类型：在模板文件中保留
ruleType为Always、Auto Attached、Model Request、Manual中的一种。 - 编写规则描述：将
description of the rules替换为规则功能的准确描述。对于Model Request类型的规则，这个描述尤为重要，因为它会直接传递给 AI 模型。 - 配置匹配规则（仅适用于
Auto Attached类型）：准确配置希望该规则生效的文件模式或路径；对于其他类型的规则，可以删除冒号后的内容。
团队协作与版本管理
Rules 文件可以与项目代码一起提交到远程仓库中。当团队其他成员拉取代码时，会同步获得这些规则配置，从而确保整个团队使用统一的开发规范和 AI 行为模式。这种方式极大地提升了团队协作的一致性和效率。
使用注意事项
为了确保 Rules 正常工作，请注意以下几点：
- 格式规范：规则文件的头部请遵循 YAML header 标准，避免多余的空格、换行符或特殊字符，这些可能导致解析失败。
- 规则管理：注释掉的规则文本不会导致规则失效。如果需要停用某个规则，请直接删除规则文件或清空规则文档内容。
- 文件命名：建议使用有意义的文件名，便于团队成员理解和维护。
Rules 内容建议
为了充分发挥 Rules 的作用，我们建议您在规则中包含以下内容：
基础配置项
| 配置类别 | 具体内容 | 说明 |
|---|---|---|
| 项目信息 | 项目名称、描述、版本控制信息、团队成员信息 | 帮助 AI 更好地理解项目背景 |
| 技术栈配置 | 主要编程语言、框架和库的版本要求、开发工具链设定 | 确保 AI 生成符合技术栈要求的代码 |
AI 行为规范
| 规范类别 | 具体内容 | 说明 |
|---|---|---|
| 角色定义 | 专业身份（如全栈工程师、架构师）、专业水平要求、交互风格设定 | 让 AI 以合适的角色和风格与您交互 |
| 输出规范 | 代码注释要求、文档生成规则、错误处理标准 | 统一 AI 输出的格式和质量 |
| 工作流程 | 需求分析流程、设计方案步骤、代码实现规范、测试和优化要求 | 规范 AI 的工作流程和方法 |
代码质量控制
| 质量维度 | 具体内容 | 说明 |
|---|---|---|
| 命名规范 | 变量命名规则、函数命名规则、类和接口命名规则 | 保持代码命名的一致性 |
| 代码风格 | 缩进和格式要求、代码组织规则、模块化标准 | 统一代码风格和结构 |
| 质量指标 | 代码复杂度限制、注释覆盖率要求、测试覆盖率标准 | 确保代码质量达到团队标准 |
智能化功能
| 功能类别 | 具体内容 | 说明 |
|---|---|---|
| 自动化文档 | README 自动更新、API 文档生成、变更日志维护 | 提升文档维护效率 |
| 代码优化 | 性能优化建议、代码重构提示、最佳实践推荐 | 持续改进代码质量 |
| 工具集成 | 常用函数库维护、代码模板管理、自动化工具配置 | 提升开发效率和标准化程度 |
通过合理配置这些内容，您可以让 Meituan CatPaw 的 AI 助手更好地理解您的需求，提供更精准、更符合团队规范的帮助。