UKHO.GitHubCopilot.ToolKit prompts.instructions.md

Copilot prompt naming rules

Overview

These instructions define how to name and describe Copilot prompt files in this repository. They help contributors keep prompt assets brief, consistent, and easy to understand from the file name and front matter alone.

Scope

Applies to: .github/prompts/**/*.prompt.md

• Applies when creating, renaming, or substantially restructuring prompt files under ./.github/prompts/.
• Does not apply to non-prompt markdown files that do not use the *.prompt.md naming pattern.

Instructions

MUST

• Name prompt files using lowercase kebab-case.
• Name prompt files using the pattern <verb>-<subject>[-<qualifier>].prompt.md.
• Start prompt file names with a clear action verb that describes the primary task the prompt performs.
• Use a subject that identifies the main artifact, outcome, or target of the prompt.
• Keep the front matter name field aligned with the file name stem.
  • Example: create-instructions.prompt.md MUST use name: create-instructions.
• Ensure the file name, front matter name, and prompt purpose describe the same outcome.
• Keep prompt names brief enough to scan quickly while still distinguishing the prompt from nearby files.
• Use front matter description to state the prompt's intended outcome in one clear sentence.

SHOULD

• Prefer prompt names with two to four terms before the .prompt.md suffix.
• Prefer a controlled verb set such as create, update, review, analyse, generate, refactor, validate, summarise, or troubleshoot when those verbs match the intended task.
• Add a qualifier only when it materially improves distinction.
  • Examples: security, playwright, csharp, edge-cases.
• Prefer folder structure to carry broad categorization so file names can stay focused on the prompt's specific purpose.
• Use the shortest subject wording that remains unambiguous within the prompts folder.
• When a prompt defines a planning or project-update workflow, prefer explicit instructions that tell contributors to review relevant docs/wiki/ pages before proceeding and to refresh the wiki after any resulting change.