-
Notifications
You must be signed in to change notification settings - Fork 160
docs: enhance custom instructions section with recursive loading deta… #315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…ils and AGENTS.md support
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the custom instructions documentation by clarifying recursive loading behavior and adding support for AGENTS.md files. The changes improve documentation accuracy and add a new feature for standardized agent behavior rules.
- Clarifies that rule directories are read recursively including subdirectories
- Updates the system prompt structure to show combined loading from both global and workspace directories
- Documents new AGENTS.md support for standardized AI agent behavior rules
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| # Rules from .roorules-{modeSlug}: | ||
| [Contents of .roorules-{modeSlug} file if no mode-specific directories have files] | ||
| # Rules from .rooignore: |
Copilot
AI
Aug 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The .rooignore section is mentioned in the system prompt template but not explained anywhere in the documentation. This leaves users unclear about what .rooignore-related instructions are or how they work.
docs/features/custom-instructions.md
Outdated
|
|
||
| * **Purpose:** Provides agent-specific rules and guidelines for AI behavior | ||
| * **Location:** Must be in the workspace root directory | ||
| * **Loading:** Automatically loaded by default (can be disabled via `settings.useAgentRules`) |
Copilot
AI
Aug 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The setting name settings.useAgentRules should be clarified with the full configuration path or section name to help users locate this setting in their configuration.
| * **Loading:** Automatically loaded by default (can be disabled via `settings.useAgentRules`) | |
| * **Loading:** Automatically loaded by default (can be disabled via `roo.useAgentRules` in your configuration file) |
…ils and AGENTS.md support
Important
Enhances
custom-instructions.mdwith recursive loading details and AGENTS.md support for Roo Code.custom-instructions.mdto specify recursive reading of instruction files in.roo/rules/and.roo/rules-{modeSlug}/directories, including subdirectories..roorulesif.roo/rules/is empty.AGENTS.mdorAGENT.mdin workspace root for agent-specific rules.custom-instructions.md.This description was created by
for c349476. You can customize this summary. It will automatically update as commits are pushed.