Update development instructions and guidelines #29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ython; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
- Standardized description formatting in various markdown files to use single quotes. - Added error handling utility in update-readme.js for safer file operations. - Improved title extraction logic in update-readme.js to handle frontmatter more robustly. - Updated chat modes section in README to reflect new emoji and sorted chat mode links. - Cleaned up various instruction files for better readability and consistency. - Ensured all markdown files end with a newline for better compatibility with version control.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
aaronpowell
requested changes
Jul 2, 2025
…details for custom chat modes
…y and consistency
…y and consistency in instructions
…y and consistency
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
aaronpowell
approved these changes
Jul 3, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the README generation script and standardizes documentation across instruction, prompt, and chat mode files.
- Refactored
update-readme.jsto use templated sections and safe file operations - Renamed instruction files to
.instructions.md, addedapplyTofields, and unified frontmatter formatting - Updated frontmatter quoting in prompt and chat mode files and fixed broken links/icons in
README.md
Reviewed Changes
Copilot reviewed 34 out of 39 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| update-readme.js | Introduces templating constants, safe file operations, and separate generators for sections |
| README.md | Swaps the custom chat mode icon, and updates links to the renamed .instructions.md files |
| prompts/javascript-typescript-jest.prompt.md | Converts frontmatter to single-quoted values for consistency |
| instructions/python.instructions.md | Renames extension and adds an applyTo field to specify applicable file patterns |
| chatmodes/postgresql-dba.chatmode.md | Renames the chat mode, adds the extensions tool, and improves the description on using the plugin |
Comments suppressed due to low confidence (2)
README.md:56
- [nitpick] The display name 'Javascript Typescript Jest' should be formatted consistently as 'JavaScript/TypeScript Jest' to match standard naming conventions.
- [Javascript Typescript Jest](prompts/javascript-typescript-jest.prompt.md) - Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns.
update-readme.js:270
- The variable
linkis not defined ingenerateInstructionsSection, causing URLs to be undefined. Introduceconst link = encodeURI(instructions/${file});before using it.
instructionsContent += `- [${title}](${link}) - ${customDescription}\n`;
| /** | ||
| * Generate the prompts section with an alphabetical list of all prompts | ||
| */ | ||
| function generatePromptsSection(promptsDir) { |
There was a problem hiding this comment.
[nitpick] The three section-generation functions share very similar logic. Consider abstracting the common listing pattern into a reusable helper to reduce duplication and simplify future updates.
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation Updates:
README.mdto reflect corrected file links and descriptions, such as renamingDatabase Administrator Chat Modefile topostgresql-dba.chatmode.md.README.mdto use consistent iconography, replacing🎭with🧩.Instruction File Renaming and Enhancements:
.instructions.mdextensions for clarity (e.g.,angular.mdtoangular.instructions.md). AddedapplyTofields to specify applicable file types, such as**/*.tsfor Angular instructions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Chat Mode Updates:
debug.chatmode.mdandplanner.chatmode.mdto use single quotes for consistency. [1] [2]These changes improve the organization, clarity, and usability of the documentation and configuration files, making them more consistent and easier to maintain.