You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: instructions/prompt.instructions.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,25 @@ Instructions for creating effective and maintainable prompt files that guide Git
13
13
- Primary references: VS Code documentation on prompt files and organization-specific conventions.
14
14
15
15
## Frontmatter Requirements
16
-
- Include `description` (single sentence, actionable outcome), `mode` (explicitly choose `ask`, `edit`, or `agent`), and `tools` (minimal set of tool bundles required to fulfill the prompt).
17
-
- Declare `model` when the prompt depends on a specific capability tier; otherwise inherit the active model.
18
-
- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization.
19
-
- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity.
16
+
17
+
Every prompt file should include YAML frontmatter with the following fields:
18
+
19
+
### Required/Recommended Fields
20
+
21
+
| Field | Required | Description |
22
+
|-------|----------|-------------|
23
+
|`description`| Recommended | A short description of the prompt (single sentence, actionable outcome) |
24
+
|`name`| Optional | The name shown after typing `/` in chat. Defaults to filename if not specified |
25
+
|`agent`| Recommended | The agent to use: `ask`, `edit`, `agent`, or a custom agent name. Defaults to current agent |
26
+
|`model`| Optional | The language model to use. Defaults to currently selected model |
27
+
|`tools`| Optional | List of tool/tool set names available for this prompt |
28
+
|`argument-hint`| Optional | Hint text shown in chat input to guide user interaction |
29
+
30
+
### Guidelines
31
+
32
+
- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity
33
+
- If `tools` are specified and current agent is `ask` or `edit`, the default agent becomes `agent`
34
+
- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization
20
35
21
36
## File Naming and Placement
22
37
- Use kebab-case filenames ending with `.prompt.md` and store them under `.github/prompts/` unless your workspace standard specifies another directory.
0 commit comments