github/awesome-copilot

code-exemplars-blueprint-generator

Technology-agnostic prompt generator that creates customizable AI prompts for scanning codebases and identifying high-quality code exemplars.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/github/awesome-copilot --skill code-exemplars-blueprint-generator

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Code Exemplars Blueprint Generator

Configuration Variables

${PROJECTTYPE="Auto-detect|.NET|Java|JavaScript|TypeScript|React|Angular|Python|Other"} <!-- Primary technology --> ${SCANDEPTH="Basic|Standard|Comprehensive"} <!-- How deeply to analyze the codebase --> ${INCLUDECODESNIPPETS=true|false} <!-- Include actual code snippets in addition to file references --> ${CATEGORIZATION="Pattern Type|Architecture Layer|File Type"} <!-- How to organize exemplars --> ${MAXEXAMPLESPERCATEGORY=3} <!-- Maximum number of examples per category --> ${INCLUDECOMMENTS=true|false} <!-- Include explanatory comments for each exemplar -->

Generated Prompt

"Scan this codebase and generate an exemplars.md file that identifies high-quality, representative code examples. The exemplars should demonstrate our coding standards and patterns to help maintain consistency. Use the following approach:

1. Codebase Analysis Phase

  • ${PROJECTTYPE == "Auto-detect" ? "Automatically detect primary programming languages and frameworks by scanning file extensions and configuration files" : `Focus on ${PROJECTTYPE} code files`}
  • Identify files with high-quality implementation, good documentation, and clear structure
  • Look for commonly used patterns, architecture components, and well-structured implementations
  • Prioritize files that demonstrate best practices for our technology stack
  • Only reference actual files that exist in the codebase - no hypothetical examples

2. Exemplar Identification Criteria

  • Well-structured, readable code with clear naming conventions
  • Comprehensive comments and documentation
  • Proper error handling and validation
  • Adherence to design patterns and architectural principles
  • Separation of concerns and single responsibility principle
  • Efficient implementation without code smells
  • Representative of our standard approaches

3. Core Pattern Categories

${PROJECTTYPE == ".NET" || PROJECTTYPE == "Auto-detect" ? `#### .NET Exemplars (if detected)

  • Domain Models: Find entities that properly implement encapsulation and domain logic
  • Repository Implementations: Examples of our data access approach
  • Service Layer Components: Well-structured business logic implementations
  • Controller Patterns: Clean API controllers with proper validation and responses
  • Dependency Injection Usage: Good examples of DI configuration and usage
  • Middleware Components: Custom middleware implementations
  • Unit Test Patterns: Well-structured tests with proper arrangement and assertions` : ""}

${(PROJECTTYPE == "JavaScript" || PROJECTTYPE == "TypeScript" || PROJECTTYPE == "React" || PROJECTTYPE == "Angular" || PROJECT_TYPE == "Auto-detect") ? `#### Frontend Exemplars (if detected)

  • Component Structure: Clean, well-structured components
  • State Management: Good examples of state handling
  • API Integration: Well-implemented service calls and data handling
  • Form Handling: Validation and submission patterns
  • Routing Implementation: Navigation and route configuration
  • UI Components: Reusable, well-structured UI elements
  • Unit Test Examples: Component and service tests` : ""}

${PROJECTTYPE == "Java" || PROJECTTYPE == "Auto-detect" ? `#### Java Exemplars (if detected)

  • Entity Classes: Well-designed JPA entities or domain models
  • Service Implementations: Clean service layer components
  • Repository Patterns: Data access implementations
  • Controller/Resource Classes: API endpoint implementations
  • Configuration Classes: Application configuration
  • Unit Tests: Well-structured JUnit tests` : ""}

${PROJECTTYPE == "Python" || PROJECTTYPE == "Auto-detect" ? `#### Python Exemplars (if detected)

  • Class Definitions: Well-structured classes with proper documentation
  • API Routes/Views: Clean API implementations
  • Data Models: ORM model definitions
  • Service Functions: Business logic implementations
  • Utility Modules: Helper and utility functions
  • Test Cases: Well-structured unit tests` : ""}

4. Architecture Layer Exemplars

  • Presentation Layer:
  • User interface components
  • Controllers/API endpoints
  • View models/DTOs
  • Business Logic Layer:
  • Service implementations
  • Business logic components
  • Workflow orchestration
  • Data Access Layer:
  • Repository implementations
  • Data models
  • Query patterns
  • Cross-Cutting Concerns:
  • Logging implementations
  • Error handling
  • Authentication/authorization
  • Validation

5. Exemplar Documentation Format

For each identified exemplar, document:

  • File path (relative to repository root)
  • Brief description of what makes it exemplary
  • Pattern or component type it represents

${INCLUDECOMMENTS ? "- Key implementation details and coding principles demonstrated" : ""} ${INCLUDECODE_SNIPPETS ? "- Small, representative code snippet (if applicable)" : ""}

${SCAN_DEPTH == "Comprehensive" ? `### 6. Additional Documentation

  • Consistency Patterns: Note consistent patterns observed across the codebase
  • Architecture Observations: Document architectural patterns evident in the code
  • Implementation Conventions: Identify naming and structural conventions
  • Anti-patterns to Avoid: Note any areas where the codebase deviates from best practices` : ""}

${SCAN_DEPTH == "Comprehensive" ? "7" : "6"}. Output Format

Create exemplars.md with:

  1. Introduction explaining the purpose of the document
  2. Table of contents with links to categories
  3. Organized sections based on ${CATEGORIZATION}
  4. Up to ${MAXEXAMPLESPER_CATEGORY} exemplars per category
  5. Conclusion with recommendations for maintaining code quality

The document should be actionable for developers needing guidance on implementing new features consistent with existing patterns.

Important: Only include actual files from the codebase. Verify all file paths exist. Do not include placeholder or hypothetical examples. "

Expected Output

Upon running this prompt, GitHub Copilot will scan your codebase and generate an exemplars.md file containing real references to high-quality code examples in your repository, organized according to your selected parameters.

タスクに関連する項目

同じリポジトリから

関連する Skills

すべての Skills
github
公式

anti-ui-slop

Stop coding agents from shipping generic UI. Use UIZZE''s 800,000+ real web and iOS screens to build product-specific interfaces, define a design contract, cover required states, and run a hard finish gate. Use when designing, implementing, redesigning, critiquing, or pre-ship reviewing a web or iOS interface in Codex, Claude Code, Cursor, Copilot, or another coding agent. Trigger with "anti-ui-slop", "stop UI slop", "ground this UI in real screens", or "run the UI finish gate".

1時間の導入数
7
GitHub Stars
4.1万
更新日
11月20日
github
公式

javascript-typescript-jest

Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns.

1時間の導入数
4
GitHub Stars
4.1万
更新日
11月20日
github
公式

multi-stage-dockerfile

Create optimized multi-stage Dockerfiles for any language or framework

24時間の導入数
446
GitHub Stars
4.1万
更新日
11月20日
github
公式

sql-code-review

Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage.

24時間の導入数
437
GitHub Stars
4.1万
更新日
11月20日