copilot-instructions-blueprint-generator

Technology-agnostic blueprint generator for creating comprehensive copilot-instructions.md files that guide GitHub Copilot to produce code consistent with project standards, architecture patterns, and exact technology versions by analyzing existing codebase patterns and avoiding assumptions.

By github · 8,989 installs

npx skills add github/awesome-copilot --skill copilot-instructions-blueprint-generator

Source repository · Upstream listing

Copilot Instructions Blueprint Generator Configuration Variables ${PROJECT TYPE="Auto detect .NET Java JavaScript TypeScript React Angular Python Multiple Other"} <! Primary technology ${ARCHITECTURE STYLE="Layered Microservices Monolithic Domain Driven Event Driven Serverless Mixed"} <! Architectural approach ${CODE QUALITY FOCUS="Maintainability Performance Security Accessibility Testability All"} <! Quality priorities ${DOCUMENTATION LEVEL="Minimal Standard Comprehensive"} <! Documentation requirements ${TESTING REQUIREMENTS="Unit Integration E2E TDD BDD All"} <! Testing approach ${VERSIONING="Semantic CalVer Custom"} <! Versioning approach Generated Prompt "Generate a comprehensive copilot instructions.md file that will guide GitHub Copilot to produce code consistent with our project's standards, architecture, and technology versions. The instructions must be strictly based on actual code patterns in our codebase and avoid making any assumptions. Follow this approach: 1. Core Instruction Structure 2. Codebase Analysis Instructions To create the copilot instructions.md file, first analyze the codebase to: 1. Identify Exact Technology Versions : ${PROJECT TYPE == "Auto detect" ? "Detect all programming languages, frameworks, and libraries by scanning file extensions and configuration files" : Focus on ${PROJECT TYPE} technologies } Extract precise version information from project files, package.json, .csproj, etc. Document version constraints and compatibility requirements 2. Understand Architecture : Analyze folder structure and module organization Identify clear layer boundaries and component relationships Document communication patterns between components 3. Document Code Patterns : Catalog naming conventions for different code elements Note documentation styles and completeness Document error handling patterns Map testing approaches and coverage 4. Note Quality Standards : Identify performance optimization techniques actually used Document security practices implemented in the code Note accessibility features present (if applicable) Document code quality patterns evident in the codebase 3. Implementation Notes The final copilot instructions.md should: Be placed in the .github/copilot directory Reference only patterns and standards that exist in the codebase Include explicit version compatibility requirements Avoid prescribing any practices not evident in the code Provide concrete examples from the codebase Be comprehensive yet concise enough for Copilot to effectively use Important: Only include guidance based on patterns actually observed in the codebase. Explicitly instruct Copilot to prioritize consistency with existing code over external best practices or newer language features. " Expected Output A comprehensive copilot instructions.md file that will guide GitHub Copilot to produce code that is perfectly compatible with your existing technology versions and follows your established patterns and architecture.