create-readme

द्वारा github

परियोजनाओं के लिए पेशेवर संरचना और फ़ॉर्मेटिंग के साथ व्यापक README.md फ़ाइलें तैयार करता है। संपूर्ण प्रोजेक्ट वर्कस्पेस का विश्लेषण करके प्रासंगिक रूप से सटीक, सुव्यवस्थित दस्तावेज़ीकरण बनाता है। सेटअप, उपयोग और मुख्य विशेषताओं के लिए स्पष्ट अनुभागों के साथ सिद्ध ओपन-सोर्स README पैटर्न का पालन करता है। बेहतर पठनीयता और दृश्य पदानुक्रम के लिए GitHub फ्लेवर्ड मार्कडाउन और एडमोनिशन

npx skills add https://github.com/github/awesome-copilot --skill create-readme
ZIP डाउनलोड करेंGitHub
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.

github की और Skills

debugging-workflows
github
GitHub एजेंटिक वर्कफ़्लो को डीबग करने के लिए गाइड - लॉग का विश्लेषण, रन का ऑडिट, और समस्याओं का समाधान
go-codemod
github
gh aw fix कमांड के लिए Go कोडमॉड को लागू और परीक्षण करें।
acreadiness-policy
github
उपयोगकर्ता को AgentRC नीति चुनने, लिखने या लागू करने में सहायता करें। नीतियाँ अप्रासंगिक जाँचों को अक्षम करके, प्रभाव/स्तर को ओवरराइड करके, सेट करके तत्परता स्कोरिंग को अनुकूलित करती हैं…
ai-ready
github
किसी भी रिपॉजिटरी को AI-तैयार बनाएं — आपके कोडबेस का विश्लेषण करता है और AGENTS.md, copilot-instructions.md, CI वर्कफ़्लो, इश्यू टेम्पलेट और अधिक जनरेट करता है। आपकी PR समीक्षा को माइन करता है…
create-oo-component-documentation
github
वस्तु-उन्मुख घटकों के लिए उद्योग की सर्वोत्तम प्रथाओं और वास्तुकला दस्तावेज़ीकरण मानकों का पालन करते हुए व्यापक, मानकीकृत दस्तावेज़ीकरण तैयार करें।
dependabot
github
Dependabot GitHub का अंतर्निहित निर्भरता प्रबंधन उपकरण है जिसमें तीन मुख्य क्षमताएँ हैं:
doublecheck
github
AI आउटपुट के लिए तीन-स्तरीय सत्यापन पाइपलाइन। सत्यापन योग्य दावों को निकालता है, वेब खोज के माध्यम से समर्थन या विरोधाभासी स्रोत ढूंढता है, प्रतिकूल समीक्षा चलाता है…
foundry-agent-sync
github
Azure AI Foundry में REST API के माध्यम से स्थानीय JSON मैनिफेस्ट से प्रॉम्प्ट-आधारित AI एजेंट बनाएं और सिंक्रोनाइज़ करें। स्कैफोल्डिंग कौशल के विपरीत जो केवल…