From a162ee3e1dc2e58b5299c60d8deac51016c47ea4 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Fri, 22 Aug 2025 09:07:51 +1000 Subject: [PATCH] Adding improved instructions back in --- README.md | 35 ++++++++++++++++++++++++++++++++--- update-readme.js | 35 ++++++++++++++++++++++++++++++++--- 2 files changed, 64 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e64c1f7..6879613 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,18 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) ## 📋 Custom Instructions Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices: -> 💡 **Usage**: Copy these instructions to your `.github/copilot-instructions.md` file or create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder. +Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices. + +### How to Use Custom Instructions + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the instruction you want to use +- Download the `*.instructions.md` file and manually add it to your project's instruction collection + +**To Use/Apply:** +- Copy these instructions to your `.github/copilot-instructions.md` file in your workspace +- Create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder +- Instructions automatically apply to Copilot behavior once installed in your workspace | Title | Description | | ----- | ----------- | @@ -99,7 +110,16 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for ## 🎯 Reusable Prompts Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools. -> 💡 **Usage**: Use `/prompt-name` in VS Code chat, run `Chat: Run Prompt` command, or hit the run button while you have a prompt open. +### How to Use Reusable Prompts + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the prompt you want to use +- Download the `*.prompt.md` file and manually add it to your prompt collection + +**To Run/Execute:** +- Use `/prompt-name` in VS Code chat after installation +- Run the `Chat: Run Prompt` command from the Command Palette +- Hit the run button while you have a prompt file open in VS Code | Title | Description | | ----- | ----------- | @@ -184,7 +204,16 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi ## 🧩 Custom Chat Modes Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows. -> 💡 **Usage**: Create new chat modes using the command `Chat: Configure Chat Modes...`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode. +### How to Use Custom Chat Modes + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the chat mode you want to use +- Download the `*.chatmode.md` file and manually install it in VS Code using the Command Palette + +**To Activate/Use:** +- Import the chat mode configuration into your VS Code settings +- Access the installed chat modes through the VS Code Chat interface +- Select the desired chat mode from the available options in VS Code Chat | Title | Description | | ----- | ----------- | diff --git a/update-readme.js b/update-readme.js index 72266d5..22789a6 100755 --- a/update-readme.js +++ b/update-readme.js @@ -35,19 +35,48 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices:`, - instructionsUsage: `> 💡 **Usage**: Copy these instructions to your \`.github/copilot-instructions.md\` file or create task-specific \`.github/.instructions.md\` files in your workspace's \`.github/instructions\` folder.`, + instructionsUsage: `Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices. + +### How to Use Custom Instructions + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the instruction you want to use +- Download the \`*.instructions.md\` file and manually add it to your project's instruction collection + +**To Use/Apply:** +- Copy these instructions to your \`.github/copilot-instructions.md\` file in your workspace +- Create task-specific \`.github/.instructions.md\` files in your workspace's \`.github/instructions\` folder +- Instructions automatically apply to Copilot behavior once installed in your workspace`, promptsSection: `## 🎯 Reusable Prompts Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools.`, - promptsUsage: `> 💡 **Usage**: Use \`/prompt-name\` in VS Code chat, run \`Chat: Run Prompt\` command, or hit the run button while you have a prompt open.`, + promptsUsage: `### How to Use Reusable Prompts + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the prompt you want to use +- Download the \`*.prompt.md\` file and manually add it to your prompt collection + +**To Run/Execute:** +- Use \`/prompt-name\` in VS Code chat after installation +- Run the \`Chat: Run Prompt\` command from the Command Palette +- Hit the run button while you have a prompt file open in VS Code`, chatmodesSection: `## 🧩 Custom Chat Modes Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows.`, - chatmodesUsage: `> 💡 **Usage**: Create new chat modes using the command \`Chat: Configure Chat Modes...\`, then switch your chat mode in the Chat input from _Agent_ or _Ask_ to your own mode.`, + chatmodesUsage: `### How to Use Custom Chat Modes + +**To Install:** +- Click the **VS Code** or **VS Code Insiders** install button for the chat mode you want to use +- Download the \`*.chatmode.md\` file and manually install it in VS Code using the Command Palette + +**To Activate/Use:** +- Import the chat mode configuration into your VS Code settings +- Access the installed chat modes through the VS Code Chat interface +- Select the desired chat mode from the available options in VS Code Chat`, footer: `## 📚 Additional Resources