josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md and update-readme.js for improved instruction clarity and consistency

Browse Source
This commit is contained in:
James Montemagno 2025-07-02 16:53:53 -07:00
parent 910e50db8a
commit 051169eca0
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -23,24 +23,24 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
- [Angular Development Instructions](instructions/angular.instructions.md) - Instruction specific coding standards and best practices - [Angular Development Instructions](instructions/angular.instructions.md) - Instruction specific coding standards and best practices
- [ASP.NET REST API Development](instructions/aspnet-rest-apis.instructions.md) - Development specific coding standards and best practices - [ASP.NET REST API Development](instructions/aspnet-rest-apis.instructions.md) - Development specific coding standards and best practices
- [Azure Functions Typescript.Instructions](instructions/azure-functions-typescript.instructions.md) - Typescript.Instruction specific coding standards and best practices - [Azure Functions Typescript](instructions/azure-functions-typescript.instructions.md) - Typescript specific coding standards and best practices
- [Bicep Code Best Practices.Instructions](instructions/bicep-code-best-practices.instructions.md) - Practices.Instruction specific coding standards and best practices - [Bicep Code Best Practices](instructions/bicep-code-best-practices.instructions.md) - Practice specific coding standards and best practices
- [Blazor.Instructions](instructions/blazor.instructions.md) - Blazor.Instruction specific coding standards and best practices - [Blazor](instructions/blazor.instructions.md) - Blazor specific coding standards and best practices
- [Cmake Vcpkg.Instructions](instructions/cmake-vcpkg.instructions.md) - Vcpkg.Instruction specific coding standards and best practices - [Cmake Vcpkg](instructions/cmake-vcpkg.instructions.md) - Vcpkg specific coding standards and best practices
- [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md) - Instruction specific coding standards and best practices - [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md) - Instruction specific coding standards and best practices
- [C# Development](instructions/csharp.instructions.md) - Development specific coding standards and best practices - [C# Development](instructions/csharp.instructions.md) - Development specific coding standards and best practices
- [.NET MAUI](instructions/dotnet-maui.instructions.md) - MAUI specific coding standards and best practices - [.NET MAUI](instructions/dotnet-maui.instructions.md) - MAUI specific coding standards and best practices
- [Genaiscript.Instructions](instructions/genaiscript.instructions.md) - Genaiscript.Instruction specific coding standards and best practices - [Genaiscript](instructions/genaiscript.instructions.md) - Genaiscript specific coding standards and best practices
- [Generate Modern Terraform Code For Azure.Instructions](instructions/generate-modern-terraform-code-for-azure.instructions.md) - Azure.Instruction specific coding standards and best practices - [Generate Modern Terraform Code For Azure](instructions/generate-modern-terraform-code-for-azure.instructions.md) - Azure specific coding standards and best practices
- [Guidance for Localization](instructions/localization.instructions.md) - Localization specific coding standards and best practices - [Guidance for Localization](instructions/localization.instructions.md) - Localization specific coding standards and best practices
- [Markdown.Instructions](instructions/markdown.instructions.md) - Markdown.Instruction specific coding standards and best practices - [Markdown](instructions/markdown.instructions.md) - Markdown specific coding standards and best practices
- [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.instructions.md) - Instruction specific coding standards and best practices - [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.instructions.md) - Instruction specific coding standards and best practices
- [Python Coding Conventions](instructions/python.instructions.md) - Convention specific coding standards and best practices - [Python Coding Conventions](instructions/python.instructions.md) - Convention specific coding standards and best practices
> 💡 **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. > 💡 **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.
## 🎭 Custom Chat Modes ## 🧩 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. Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows.

11
update-readme.js
View File

@ -49,8 +49,8 @@ function extractTitle(filePath) {
inFrontmatter = false; inFrontmatter = false;
frontmatterEnded = false; frontmatterEnded = false;
// Step 2: For prompt/chatmode files, look for heading after frontmatter // Step 2: For prompt/chatmode/instructions files, look for heading after frontmatter
if (filePath.includes(".prompt.md") || filePath.includes(".chatmode.md")) { if (filePath.includes(".prompt.md") || filePath.includes(".chatmode.md") || filePath.includes(".instructions.md")) {
for (const line of lines) { for (const line of lines) {
if (line.trim() === "---") { if (line.trim() === "---") {
if (!inFrontmatter) { if (!inFrontmatter) {
@ -66,10 +66,11 @@ function extractTitle(filePath) {
} }
} }
// Step 3: Format filename for prompt/chatmode files if no heading found // Step 3: Format filename for prompt/chatmode/instructions files if no heading found
const basename = path.basename( const basename = path.basename(
filePath, filePath,
filePath.includes(".prompt.md") ? ".prompt.md" : ".chatmode.md" filePath.includes(".prompt.md") ? ".prompt.md" :
filePath.includes(".chatmode.md") ? ".chatmode.md" : ".instructions.md"
); );
return basename return basename
.replace(/[-_]/g, " ") .replace(/[-_]/g, " ")
@ -433,7 +434,7 @@ function updateChatModesSection(currentReadme, chatmodeFiles, chatmodesDir) {
// Replace the current chat modes section with the updated one // Replace the current chat modes section with the updated one
const newChatmodesSection = const newChatmodesSection =
"## 🎭 Custom Chat Modes\n\nCustom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows." + "## 🧩 Custom Chat Modes\n\nCustom chat modes define specific behaviors and tools for GitHub Copilot Chat, enabling enhanced context-aware assistance for particular tasks or workflows." +
chatmodesListContent + chatmodesListContent +
"\n> 💡 **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."; "\n> 💡 **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.";