Global Coding Standards
Global Coding Standards【免费下载链接】Roo-CodeRoo Code gives you a whole dev team of AI agents in your code editor.项目地址: https://gitcode.com/GitHub_Trending/ro/Roo-CodeAlways use TypeScript for new projectsWrite unit tests for all new functionsUse descriptive variable namesAdd JSDoc comments for public APIs模式专属规则示例~/.roo/rules-code/typescript-rules.md markdown # TypeScript Code Mode Rules 1. Use strict mode in tsconfig.json 2. Prefer interfaces over type aliases for object shapes 3. Always specify return types for functions可用规则目录一览目录用途rules/适用于所有模式的通用规则rules-code/Code 模式专属规则rules-docs-extractor/文档提取规则rules-architect/架构设计任务规则rules-debug/调试工作流规则rules-{mode}/任意自定义模式的规则5.4 工作区规则目录优先、单文件回退首选目录方式.roo/rules/. ├── .roo/ │ └── rules/ # 工作区通用规则 │ ├── 01-general.md │ └── 02-coding-style.txt └── ... (其他项目文件)回退单文件方式.roorules/ 遗留.clinerules. ├── .roorules # 工作区通用规则单文件 └── ... (其他项目文件)模式专属目录方式为.roo/rules-{modeSlug}/如.roo/rules-docs-writer/回退单文件为.roorules-{modeSlug}如.roorules-code遗留文件为.clinerules-{modeSlug}。目录方式下的文件会被递归读取含子目录并按文件名字母序不区分大小写拼入系统提示词。若目录存在但为空则回退到单文件方式。5.5 源码级实现规则是如何被加载的规则加载的核心实现在 src/core/prompts/sections/custom-instructions.ts 的addCustomInstructions函数中其组装顺序与官方文档完全对应语言偏好若设置全局指令Prompts 面板中的 “Global Instructions”模式专属指令Prompts 面板中当前模式的指令Rules 段落按以下顺序追加模式专属规则.roo/rules-{mode}/目录或回退.roorules-{mode}/.clinerules-{mode}.rooignore相关指令AGENTS.md 内容若启用useAgentRules通用规则~/.roo/rules/与.roo/rules/目录或回退.roorules/.clinerules。loadRuleFiles见 custom-instructions.ts清晰地体现了“目录优先、单文件回退”的策略先遍历所有.roo/rules/目录只有全部为空时才回退读取.roorules与.clinerules遗留文件。模式专属规则的目录解析rules-${mode}则复用同一套逻辑见 custom-instructions.ts。关于.rules文件还有若干工程细节递归读取规则目录递归遍历包含所有子目录中的文件文件过滤自动排除缓存与临时文件.DS_Store、*.bak、*.cache、*.log、*.tmp、Thumbs.db等完整清单见shouldIncludeRuleFile实现空文件空或缺失的规则文件被静默跳过来源头目录方式为每个文件生成# Rules from {相对路径}:头单文件方式为# Rules from {文件名}:头聚合而非二选一全局与工作区规则目录会聚合加载模式专属与通用规则同理符号链接文件与目录的符号链接均受支持最大解析深度 5 层以防止循环引用见 custom-instructions.ts。5.6 Prompts 面板方式除了文件还可以通过界面设置自定义指令点击 Roo Code 顶部菜单栏的笔记本图标打开 Prompts 面板在 “Custom Instructions for All Modes” 区域输入全局指令在 Modes 标题下选择具体模式即可设置该模式的 “Mode-specific Custom Instructions”。如果该模式本身是全局模式非工作区专属其指令也会跨工作区全局生效。5.7 最终拼入系统提示词的格式所有来源的指令最终以如下结构写入系统提示词 USERS CUSTOM INSTRUCTIONS The following additional instructions are provided by the user, and should be followed to the best of your ability without interfering with the TOOL USE guidelines. Language Preference: [语言偏好若设置] Global Instructions: [Prompts 面板中的全局指令] Mode-specific Instructions: [当前模式的 Prompts 面板指令] Rules: # Rules from rules-{modeSlug} directories: [~/.roo/rules-{modeSlug}/ 与 .roo/rules-{modeSlug}/ 中所有文件的内容] # Rules from .roorules-{modeSlug}: [.roorules-{modeSlug} 文件内容目录无文件时的回退] # Rules from .rooignore: [.rooignore 相关指令若适用] # Agent Rules Standard (AGENTS.md): [工作区根目录 AGENTS.md / AGENT.md 的内容若启用] # Rules from rules directories: [~/.roo/rules/ 与 .roo/rules/ 中所有文件的内容] # Rules from .roorules: [.roorules 文件内容目录无文件时的回退] 【免费下载链接】Roo-CodeRoo Code gives you a whole dev team of AI agents in your code editor.项目地址: https://gitcode.com/GitHub_Trending/ro/Roo-Code创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考