Update development instructions and guidelines (#29)

* Delete outdated development instructions for Next.js + Tailwind and Python; 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.

* Update documentation and prompts for consistency and clarity

- 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.

* Remove standardize-frontmatter.js script

* Add usage instructions for creating and switching chat modes in README.md

* Update README.md generation script to enhance instructions and usage details for custom chat modes

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

* Refactor README.md links and update readme script for improved clarity and consistency in instructions

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

* Changing from a patch to regen approach for the readme

* Bit more cleanup for how to show things in the readme

* Adding missing description

* Another missing description

---------

Co-authored-by: Aaron Powell <me@aaron-powell.com>
This commit is contained in:
James Montemagno
2025-07-02 18:18:52 -07:00
committed by GitHub
parent d1256681e7
commit 6fb794bc79
39 changed files with 447 additions and 486 deletions

View File

@@ -1,6 +1,6 @@
---
description: |
Angular-specific coding standards and best practices
description: 'Angular-specific coding standards and best practices'
applyTo: '**/*.ts, **/*.html, **/*.scss, **/*.css'
---
# Angular Development Instructions

View File

@@ -1,5 +1,6 @@
---
description: Guidelines for building REST APIs with ASP.NET
description: 'Guidelines for building REST APIs with ASP.NET'
applyTo: '**/*.cs, **/*.json'
---
# ASP.NET REST API Development

View File

@@ -1,5 +1,6 @@
---
description: TypeScript patterns for Azure Functions
description: 'TypeScript patterns for Azure Functions'
applyTo: '**/*.ts, **/*.js, **/*.json'
---
## Guidance for Code Generation
@@ -10,4 +11,4 @@ description: TypeScript patterns for Azure Functions
- Ask before adding any extra dependencies to the project
- The API is built using Azure Functions using `@azure/functions@4` package.
- Each endpoint should have its own function file, and use the following naming convention: `src/functions/<resource-name>-<http-verb>.ts`
- When making changes to the API, make sure to update the OpenAPI schema (if it exists) and `README.md` file accordingly.
- When making changes to the API, make sure to update the OpenAPI schema (if it exists) and `README.md` file accordingly.

View File

@@ -1,6 +1,6 @@
---
description: Infrastructure as Code with Bicep
applyTo: "**/*.bicep"
description: 'Infrastructure as Code with Bicep'
applyTo: '**/*.bicep'
---
## Naming Conventions

View File

@@ -1,6 +1,6 @@
---
description: Blazor component and application patterns
applyTo: "**/*.razor, **/*.razor.cs, **/*.razor.css"
description: 'Blazor component and application patterns'
applyTo: '**/*.razor, **/*.razor.cs, **/*.razor.css'
---
## Blazor Code Style and Structure

View File

@@ -1,5 +1,6 @@
---
description: C++ project configuration and package management
description: 'C++ project configuration and package management'
applyTo: '**/*.cmake, **/CMakeLists.txt, **/*.cpp, **/*.h, **/*.hpp'
---
This project uses vcpkg in manifest mode. Please keep this in mind when giving vcpkg suggestions. Do not provide suggestions like vcpkg install library, as they will not work as expected.

View File

@@ -1,6 +1,5 @@
---
applyTo: '**'
mode: "agent"
description: 'See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed'
---
@@ -60,4 +59,4 @@ description: 'See process Copilot is following where you can edit this to reshap
- NEVER continue past current phase without user input
- If you catch yourself being verbose, STOP and provide only required output
- If you catch yourself about to skip a phase, STOP and go back to the correct phase
- If you catch yourself combining phases, STOP and perform only the current phase
- If you catch yourself combining phases, STOP and perform only the current phase

View File

@@ -1,5 +1,6 @@
---
description: Guidelines for building C# applications
description: 'Guidelines for building C# applications'
applyTo: '**/*.cs'
---
# C# Development

View File

@@ -1,12 +1,14 @@
---
description: MAUI component and application patterns
appliesTo: "**/*.xaml, **/*.cs"
description: '.NET MAUI component and application patterns'
applyTo: '**/*.xaml, **/*.cs'
---
## MAUI Code Style and Structure
# .NET MAUI
- Write idiomatic and efficient MAUI and C# code.
- Follow .NET and MAUI conventions.
## .NET MAUI Code Style and Structure
- Write idiomatic and efficient .NET MAUI and C# code.
- Follow .NET and .NET MAUI conventions.
- Prefer inline functions for smaller components but separate complex logic into code-behind or service classes.
- Async/await should be used where applicable to ensure non-blocking UI operations.
@@ -16,16 +18,16 @@ appliesTo: "**/*.xaml, **/*.cs"
- Use camelCase for private fields and local variables.
- Prefix interface names with "I" (e.g., IUserService).
## MAUI and .NET Specific Guidelines
## .NET MAUI and .NET Specific Guidelines
- Utilize MAUI's built-in features for component lifecycle (e.g. OnAppearing, OnDisappearing).
- Utilize .NET MAUI's built-in features for component lifecycle (e.g. OnAppearing, OnDisappearing).
- Use data binding effectively with {Binding}.
- Structure MAUI components and services following Separation of Concerns.
- Structure .NET MAUI components and services following Separation of Concerns.
- Always use the latest version C#, currently C# 13 features like record types, pattern matching, and global usings.
## Error Handling and Validation
- Implement proper error handling for MAUI pages and API calls.
- Implement proper error handling for .NET MAUI pages and API calls.
- Use logging for error tracking in the backend and consider capturing UI-level errors in MAUI with tools like MAUI Community Toolkit's Logger.
- Implement validation using FluentValidation or DataAnnotations in forms.

View File

@@ -1,6 +1,6 @@
---
applyTo: "**/*.genai.*"
description: AI-powered script generation guidelines
description: 'AI-powered script generation guidelines'
applyTo: '**/*.genai.*'
---
## Role

View File

@@ -1,6 +1,6 @@
---
description: Guidelines for generating modern Terraform code for Azure
applyTo: "**/*.tf"
description: 'Guidelines for generating modern Terraform code for Azure'
applyTo: '**/*.tf'
---
## 1. Use Latest Terraform and Providers
@@ -79,4 +79,4 @@ Use Terraform modules to group reusable infrastructure components. For any resou
- **Consider implementing automated checks**:
- CI pipeline
- Pre-commit hooks
- Enforce formatting, linting, and basic validation
- Enforce formatting, linting, and basic validation

View File

@@ -1,6 +1,6 @@
---
description: Guidelines for localizing markdown documents
applyTo: "**/*.md"
description: 'Guidelines for localizing markdown documents'
applyTo: '**/*.md'
---
# Guidance for Localization

View File

@@ -1,6 +1,6 @@
---
description: Documentation and content creation standards
applyTo: "**/*.md"
description: 'Documentation and content creation standards'
applyTo: '**/*.md'
---
## Markdown Content Rules

View File

@@ -1,5 +1,6 @@
---
description: Next.js + Tailwind development standards and instructions
description: 'Next.js + Tailwind development standards and instructions'
applyTo: '**/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css'
---
# Next.js + Tailwind Development Instructions
@@ -68,4 +69,4 @@ Instructions for high-quality Next.js applications with Tailwind CSS styling and
5. Add proper error handling
6. Implement responsive styling
7. Add loading states
8. Write tests
8. Write tests

View File

@@ -1,5 +1,6 @@
---
description: Python coding conventions and guidelines
description: 'Python coding conventions and guidelines'
applyTo: '**/*.py'
---
# Python Coding Conventions
@@ -52,4 +53,4 @@ def calculate_area(radius: float) -> float:
"""
import math
return math.pi * radius ** 2
```
```