create-readme

von github

Erstellt umfassende README.md-Dateien für Projekte mit professioneller Struktur und Formatierung. Analysiert den gesamten Projektarbeitsbereich, um kontextuell genaue, gut organisierte Dokumentation zu erstellen. Folgt bewährten Open-Source-README-Mustern mit klaren Abschnitten für Einrichtung, Nutzung und Hauptfunktionen. Verwendet GitHub Flavored Markdown und Admonition-Syntax für verbesserte Lesbarkeit und visuelle Hierarchie. Balanciert Detailgenauigkeit mit Prägnanz, vermeidet unnötige Abschnitte und übermäßige Emojis, während...

npx skills add https://github.com/github/awesome-copilot --skill create-readme
ZIP herunterladenGitHub
39.4k

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.

Mehr Skills von github

debugging-workflows
github
Leitfaden zum Debuggen von GitHub Agentic Workflows – Analysieren von Logs, Prüfen von Ausführungen und Beheben von Problemen
go-codemod
github
Implementieren und testen Sie Go-Codemods für den gh aw fix-Befehl.
acreadiness-policy
github
Helfen Sie dem Benutzer, eine AgentRC-Richtlinie auszuwählen, zu schreiben oder anzuwenden. Richtlinien passen die Bereitschaftsbewertung an, indem sie irrelevante Prüfungen deaktivieren, Auswirkungen/Stufen überschreiben, festlegen…
ai-ready
github
Macht jedes Repository KI-bereit – analysiert Ihre Codebasis und generiert AGENTS.md, copilot-instructions.md, CI-Workflows, Issue-Vorlagen und mehr. Analysiert Ihre PR-Überprüfung…
create-oo-component-documentation
github
Erstellen Sie umfassende, standardisierte Dokumentation für objektorientierte Komponenten gemäß Branchenstandards und Architekturdokumentationsstandards.
dependabot
github
Dependabot ist das integrierte Abhängigkeitsverwaltungstool von GitHub mit drei Kernfunktionen:
doublecheck
github
Drei-Schritte-Überprüfungspipeline für KI-Ausgaben. Extrahiert überprüfbare Behauptungen, findet unterstützende oder widersprechende Quellen über Websuche, führt gegnerische Überprüfung durch…
foundry-agent-sync
github
Erstellen und synchronisieren Sie promptbasierte KI-Agenten direkt in Azure AI Foundry über die REST-API, aus einem lokalen JSON-Manifest. Im Gegensatz zu Scaffolding-Fähigkeiten, die nur…