create-readme

por github

Gera arquivos README.md abrangentes para projetos com estrutura e formatação profissional. Analisa todo o workspace do projeto para criar documentação contextualmente precisa e bem organizada. Segue padrões comprovados de README de código aberto com seções claras para configuração, uso e principais funcionalidades. Utiliza Markdown do GitHub Flavored e sintaxe de admonição para melhor legibilidade e hierarquia visual. Equilibra detalhamento com concisão, evitando seções desnecessárias e excesso de emojis, mantendo...

npx skills add https://github.com/github/awesome-copilot --skill create-readme
Baixar ZIPGitHub
37.7k

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.

Mais skills de github

console-rendering
github
Instruções para usar o sistema de renderização de console baseado em tags de struct em Go
official
github-pr-query
github
Consulte pull requests do GitHub de forma eficiente com suporte a argumentos jq para filtragem.
official
jqschema
github
Utilitário de descoberta de esquema JSON que extrai informações de estrutura e tipo de dados
official
gh-agent-session
github
Extensão de Sessão do Agente GitHub CLI
official
gh-agent-task
github
Extensão de Tarefa do Agente GitHub CLI
official
github-copilot-agent-tips-and-tricks
github
Dicas e Truques para Trabalhar com PRs do Agente GitHub Copilot
official
rust-coding-skill
github
Use this skill whenever editing `*.rs` files in the `rust/` SDK in order to write idiomatic, efficient, well-structured Rust code
official
ai-ready
github
Torna qualquer repositório pronto para IA — analisa sua base de código e gera AGENTS.md, copilot-instructions.md, fluxos de CI, modelos de issue e mais. Explora sua revisão de PR…
official