github/awesome-copilot

readme-blueprint-generator

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation.

Vedi sorgente

Come usare

  1. Copia il comando e controlla il pacchetto prima di installarlo nel tuo ambiente agente.
  2. Controlla strumenti, credenziali e ambienti richiesti nel documento originale.
  3. Descrivi input e risultato desiderato; confronta l’output con le fonti.
npx skills add https://github.com/github/awesome-copilot --skill readme-blueprint-generator

Prima di iniziare

  • L’installazione non include abbonamenti, quote API o accesso ai file.
  • Stelle e installazioni indicano attività, non un test indipendente di qualità o sicurezza.
Documento Skill originale

Contenuto dal repository con titoli, esempi, codice, tabelle, link e immagini preservati.

README Generator Prompt

Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:

  1. Scan all the files in the .github/copilot folder, like:
  • Architecture
  • Code_Exemplars
  • Coding_Standards
  • ProjectFolderStructure
  • Technology_Stack
  • Unit_Tests
  • Workflow_Analysis
  1. Also review the copilot-instructions.md file in the .github folder
  1. Create a README.md with the following sections:

Project Name and Description

  • Extract the project name and primary purpose from the documentation
  • Include a concise description of what the project does

Technology Stack

  • List the primary technologies, languages, and frameworks used
  • Include version information when available
  • Source this information primarily from the Technology_Stack file

Project Architecture

  • Provide a high-level overview of the architecture
  • Consider including a simple diagram if described in the documentation
  • Source from the Architecture file

Getting Started

  • Include installation instructions based on the technology stack
  • Add setup and configuration steps
  • Include any prerequisites

Project Structure

  • Brief overview of the folder organization
  • Source from ProjectFolderStructure file

Key Features

  • List main functionality and features of the project
  • Extract from various documentation files

Development Workflow

  • Summarize the development process
  • Include information about branching strategy if available
  • Source from Workflow_Analysis file

Coding Standards

  • Summarize key coding standards and conventions
  • Source from the Coding_Standards file

Testing

  • Explain testing approach and tools
  • Source from Unit_Tests file

Contributing

  • Guidelines for contributing to the project
  • Reference any code exemplars for guidance
  • Source from Code_Exemplars and copilot-instructions

License

  • Include license information if available

Format the README with proper Markdown, including:

  • Clear headings and subheadings
  • Code blocks where appropriate
  • Lists for better readability
  • Links to other documentation files
  • Badges for build status, version, etc. if information is available

Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.

Correlati per attività

dallo stesso repository

Altri Skills

Tutti gli Skills
github
Ufficiale

arch-linux-triage

Triage and resolve Arch Linux issues with pacman, systemd, and rolling-release best practices.

installazioni
1
GitHub Stars
40,4K
Aggiornato
26 ott
github
Ufficiale

git-commit

Use this skill when the user wants to make a Git commit or split changes into more than one commit. Also use it when the user types "/commit" or asks for a conventional commit. The skill examines the diff, stages the related files, writes a Conventional Commits message, and runs git commit. Do not use it when the user wants only a commit message and no commit. Do not use it to push, open a pull request, rebase, or change the commit history.

installazioni
2
GitHub Stars
40,4K
Aggiornato
26 ott
github
Ufficiale

java-mcp-server-generator

Use this skill when the user wants to create a Model Context Protocol (MCP) server in Java or in a Spring Boot app. Also use it when the user wants AI agents, such as GitHub Copilot or Claude, to use Java code, an API, or a database. Use it even if the user does not say "MCP". The skill makes a Maven or Gradle project with the MCP Java SDK 2.x, tools, JUnit tests, and client configuration. Do not use it for Quarkus/Quarkiverse MCP servers (use the quarkus-mcp-server-sse instruction), for an MCP

installazioni
1
GitHub Stars
40,4K
Aggiornato
26 ott
github
Ufficiale

java-refactoring-remove-parameter

Refactoring using Remove Parameter in Java Language

installazioni
1
GitHub Stars
40,4K
Aggiornato
26 ott