create-readme

bởi github

Tạo tệp README.md toàn diện cho các dự án với cấu trúc và định dạng chuyên nghiệp. Phân tích toàn bộ không gian làm việc của dự án để tạo tài liệu chính xác theo ngữ cảnh, được tổ chức tốt. Tuân theo các mẫu README nguồn mở đã được kiểm chứng với các phần rõ ràng về thiết lập, cách sử dụng và các tính năng chính. Sử dụng GitHub Flavored Markdown và cú pháp chú thích để tăng khả năng đọc và phân cấp trực quan. Cân bằng giữa chi tiết và sự ngắn gọn, tránh các phần không cần thiết và biểu tượng cảm xúc quá mức trong khi vẫn duy trì...

npx skills add https://github.com/github/awesome-copilot --skill create-readme
Tải ZIPGitHub
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.

Thêm skills từ github

debugging-workflows
github
Hướng dẫn gỡ lỗi các quy trình tác nhân GitHub - phân tích nhật ký, kiểm tra lần chạy và khắc phục sự cố
go-codemod
github
Triển khai và kiểm thử các codemod Go cho lệnh gh aw fix.
acreadiness-policy
github
Giúp người dùng chọn, viết hoặc áp dụng chính sách AgentRC. Chính sách tùy chỉnh điểm sẵn sàng bằng cách tắt các kiểm tra không liên quan, ghi đè mức độ tác động/cấp độ, thiết lập…
ai-ready
github
Biến bất kỳ kho lưu trữ nào thành sẵn sàng cho AI — phân tích mã nguồn của bạn và tạo ra AGENTS.md, copilot-instructions.md, quy trình CI, mẫu issue, và nhiều hơn nữa. Khai thác đánh giá PR của bạn…
create-oo-component-documentation
github
Tạo tài liệu toàn diện, chuẩn hóa cho các thành phần hướng đối tượng, tuân theo các phương pháp thực hành tốt nhất trong ngành và tiêu chuẩn tài liệu kiến trúc.
dependabot
github
Dependabot là công cụ quản lý phụ thuộc tích hợp sẵn của GitHub với ba khả năng cốt lõi:
doublecheck
github
Quy trình xác minh ba lớp cho đầu ra AI. Trích xuất các tuyên bố có thể kiểm chứng, tìm nguồn hỗ trợ hoặc mâu thuẫn qua tìm kiếm web, thực hiện đánh giá đối kháng…
foundry-agent-sync
github
Tạo và đồng bộ hóa các tác nhân AI dựa trên prompt trực tiếp trong Azure AI Foundry thông qua REST API, từ một tệp kê khai JSON cục bộ. Không giống như các kỹ năng scaffolding chỉ…