Skip to content

Commit 25be233

Browse files
authored
Add description field to create_mode instructions (#5433)
* Add description field to create_mode instructions - Include description field in optional but recommended fields list - Add description field to YAML example with clear guidance - Description field already exists in ModeConfig schema but was missing from instructions - Provides short, human-readable description of what the mode does (1-2 sentences) * Update description field guidance to 5 words instead of 1-2 sentences - Changed description field guidance from '1-2 sentences' to '5 words' - Updated YAML example to show concise 5-word description - Addresses feedback from @mrubens in PR comment #3041823916
1 parent 8f216c3 commit 25be233

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/core/prompts/instructions/create-mode.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ If asked to create a project mode, create it in .roomodes in the workspace root.
2626
* groups: Array of allowed tool groups (can be empty). Each group can be specified either as a string (e.g., "edit" to allow editing any file) or with file restrictions (e.g., ["edit", { fileRegex: "\\.md$", description: "Markdown files only" }] to only allow editing markdown files)
2727
2828
- The following fields are optional but highly recommended:
29+
* description: A short, human-readable description of what this mode does (5 words)
2930
* whenToUse: A clear description of when this mode should be selected and what types of tasks it's best suited for. This helps the Orchestrator mode make better decisions.
3031
* customInstructions: Additional instructions for how the mode should operate
3132
@@ -36,15 +37,16 @@ Both files should follow this structure (in YAML format):
3637
customModes:
3738
- slug: designer # Required: unique slug with lowercase letters, numbers, and hyphens
3839
name: Designer # Required: mode display name
40+
description: UI/UX design systems expert # Optional but recommended: short description (5 words)
3941
roleDefinition: >-
4042
You are Roo, a UI/UX expert specializing in design systems and frontend development. Your expertise includes:
4143
- Creating and maintaining design systems
4244
- Implementing responsive and accessible web interfaces
4345
- Working with CSS, HTML, and modern frontend frameworks
4446
- Ensuring consistent user experiences across platforms # Required: non-empty
4547
whenToUse: >-
46-
Use this mode when creating or modifying UI components, implementing design systems,
47-
or ensuring responsive web interfaces. This mode is especially effective with CSS,
48+
Use this mode when creating or modifying UI components, implementing design systems,
49+
or ensuring responsive web interfaces. This mode is especially effective with CSS,
4850
HTML, and modern frontend frameworks. # Optional but recommended
4951
groups: # Required: array of tool groups (can be empty)
5052
- read # Read files group (read_file, fetch_instructions, search_files, list_files, list_code_definition_names)

0 commit comments

Comments
 (0)