Skip to content

Commit e948271

Browse files
authored
Adding improved instructions back in (#207)
* Adding improved instructions back in * Removing duplicate line
1 parent f9aefd9 commit e948271

File tree

2 files changed

+62
-8
lines changed

2 files changed

+62
-8
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,17 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md)
2626

2727
## 📋 Custom Instructions
2828

29-
Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices:
30-
> 💡 **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.
29+
Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices.
30+
### How to Use Custom Instructions
31+
32+
**To Install:**
33+
- Click the **VS Code** or **VS Code Insiders** install button for the instruction you want to use
34+
- Download the `*.instructions.md` file and manually add it to your project's instruction collection
35+
36+
**To Use/Apply:**
37+
- Copy these instructions to your `.github/copilot-instructions.md` file in your workspace
38+
- Create task-specific `.github/.instructions.md` files in your workspace's `.github/instructions` folder
39+
- Instructions automatically apply to Copilot behavior once installed in your workspace
3140

3241
| Title | Description |
3342
| ----- | ----------- |
@@ -100,7 +109,16 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
100109
## 🎯 Reusable Prompts
101110

102111
Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools.
103-
> 💡 **Usage**: Use `/prompt-name` in VS Code chat, run `Chat: Run Prompt` command, or hit the run button while you have a prompt open.
112+
### How to Use Reusable Prompts
113+
114+
**To Install:**
115+
- Click the **VS Code** or **VS Code Insiders** install button for the prompt you want to use
116+
- Download the `*.prompt.md` file and manually add it to your prompt collection
117+
118+
**To Run/Execute:**
119+
- Use `/prompt-name` in VS Code chat after installation
120+
- Run the `Chat: Run Prompt` command from the Command Palette
121+
- Hit the run button while you have a prompt file open in VS Code
104122

105123
| Title | Description |
106124
| ----- | ----------- |
@@ -186,7 +204,16 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
186204
## 🧩 Custom Chat Modes
187205

188206
Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows.
189-
> 💡 **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.
207+
### How to Use Custom Chat Modes
208+
209+
**To Install:**
210+
- Click the **VS Code** or **VS Code Insiders** install button for the chat mode you want to use
211+
- Download the `*.chatmode.md` file and manually install it in VS Code using the Command Palette
212+
213+
**To Activate/Use:**
214+
- Import the chat mode configuration into your VS Code settings
215+
- Access the installed chat modes through the VS Code Chat interface
216+
- Select the desired chat mode from the available options in VS Code Chat
190217

191218
| Title | Description |
192219
| ----- | ----------- |

update-readme.js

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,48 @@ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md)
3333

3434
instructionsSection: `## 📋 Custom Instructions
3535
36-
Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices:`,
36+
Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices.`,
3737

38-
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.`,
38+
instructionsUsage: `### How to Use Custom Instructions
39+
40+
**To Install:**
41+
- Click the **VS Code** or **VS Code Insiders** install button for the instruction you want to use
42+
- Download the \`*.instructions.md\` file and manually add it to your project's instruction collection
43+
44+
**To Use/Apply:**
45+
- Copy these instructions to your \`.github/copilot-instructions.md\` file in your workspace
46+
- Create task-specific \`.github/.instructions.md\` files in your workspace's \`.github/instructions\` folder
47+
- Instructions automatically apply to Copilot behavior once installed in your workspace`,
3948

4049
promptsSection: `## 🎯 Reusable Prompts
4150
4251
Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools.`,
4352

44-
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.`,
53+
promptsUsage: `### How to Use Reusable Prompts
54+
55+
**To Install:**
56+
- Click the **VS Code** or **VS Code Insiders** install button for the prompt you want to use
57+
- Download the \`*.prompt.md\` file and manually add it to your prompt collection
58+
59+
**To Run/Execute:**
60+
- Use \`/prompt-name\` in VS Code chat after installation
61+
- Run the \`Chat: Run Prompt\` command from the Command Palette
62+
- Hit the run button while you have a prompt file open in VS Code`,
4563

4664
chatmodesSection: `## 🧩 Custom Chat Modes
4765
4866
Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows.`,
4967

50-
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.`,
68+
chatmodesUsage: `### How to Use Custom Chat Modes
69+
70+
**To Install:**
71+
- Click the **VS Code** or **VS Code Insiders** install button for the chat mode you want to use
72+
- Download the \`*.chatmode.md\` file and manually install it in VS Code using the Command Palette
73+
74+
**To Activate/Use:**
75+
- Import the chat mode configuration into your VS Code settings
76+
- Access the installed chat modes through the VS Code Chat interface
77+
- Select the desired chat mode from the available options in VS Code Chat`,
5178

5279
footer: `## 📚 Additional Resources
5380

0 commit comments

Comments
 (0)