From 36d550b6da1451567090d97eabe63e091283f527 Mon Sep 17 00:00:00 2001 From: "Gordon Lam (SH)" Date: Thu, 8 Jan 2026 17:46:32 +0800 Subject: [PATCH 1/3] Update to latest standard for prompt writing --- instructions/prompt.instructions.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/instructions/prompt.instructions.md b/instructions/prompt.instructions.md index 7ca0432b1..a9ef58b94 100644 --- a/instructions/prompt.instructions.md +++ b/instructions/prompt.instructions.md @@ -13,10 +13,25 @@ Instructions for creating effective and maintainable prompt files that guide Git - Primary references: VS Code documentation on prompt files and organization-specific conventions. ## Frontmatter Requirements -- 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). -- Declare `model` when the prompt depends on a specific capability tier; otherwise inherit the active model. -- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization. -- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity. + +Every prompt file should include YAML frontmatter with the following fields: + +### Required/Recommended Fields + +| Field | Required | Description | +|-------|----------|-------------| +| `description` | Recommended | A short description of the prompt (single sentence, actionable outcome) | +| `name` | Optional | The name shown after typing `/` in chat. Defaults to filename if not specified | +| `agent` | Recommended | The agent to use: `ask`, `edit`, `agent`, or a custom agent name. Defaults to current agent | +| `model` | Optional | The language model to use. Defaults to currently selected model | +| `tools` | Optional | List of tool/tool set names available for this prompt | +| `argument-hint` | Optional | Hint text shown in chat input to guide user interaction | + +### Guidelines + +- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity +- If `tools` are specified and current agent is `ask` or `edit`, the default agent becomes `agent` +- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization ## File Naming and Placement - Use kebab-case filenames ending with `.prompt.md` and store them under `.github/prompts/` unless your workspace standard specifies another directory. From fc169457012b80629433602f5ea44d140e5cb497 Mon Sep 17 00:00:00 2001 From: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com> Date: Thu, 8 Jan 2026 18:02:02 +0800 Subject: [PATCH 2/3] Update instructions/prompt.instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- instructions/prompt.instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instructions/prompt.instructions.md b/instructions/prompt.instructions.md index a9ef58b94..ac34d08af 100644 --- a/instructions/prompt.instructions.md +++ b/instructions/prompt.instructions.md @@ -23,7 +23,7 @@ Every prompt file should include YAML frontmatter with the following fields: | `description` | Recommended | A short description of the prompt (single sentence, actionable outcome) | | `name` | Optional | The name shown after typing `/` in chat. Defaults to filename if not specified | | `agent` | Recommended | The agent to use: `ask`, `edit`, `agent`, or a custom agent name. Defaults to current agent | -| `model` | Optional | The language model to use. Defaults to currently selected model | +| `model` | Optional | The language model to use. Defaults to the currently selected model | | `tools` | Optional | List of tool/tool set names available for this prompt | | `argument-hint` | Optional | Hint text shown in chat input to guide user interaction | From 35a690f28e34d878b3e03536d8453decca479e57 Mon Sep 17 00:00:00 2001 From: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com> Date: Thu, 8 Jan 2026 18:02:10 +0800 Subject: [PATCH 3/3] Update instructions/prompt.instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- instructions/prompt.instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instructions/prompt.instructions.md b/instructions/prompt.instructions.md index ac34d08af..4485d8a87 100644 --- a/instructions/prompt.instructions.md +++ b/instructions/prompt.instructions.md @@ -30,7 +30,7 @@ Every prompt file should include YAML frontmatter with the following fields: ### Guidelines - Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity -- If `tools` are specified and current agent is `ask` or `edit`, the default agent becomes `agent` +- If `tools` are specified and the current agent is `ask` or `edit`, the default agent becomes `agent` - Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization ## File Naming and Placement