create-readme

작성자: github

프로젝트에 대해 전문적인 구조와 서식을 갖춘 포괄적인 README.md 파일을 생성합니다. 전체 프로젝트 워크스페이스를 분석하여 상황에 맞는 정확하고 체계적인 문서를 만듭니다. 설정, 사용법, 주요 기능에 대한 명확한 섹션을 갖춘 검증된 오픈소스 README 패턴을 따릅니다. GitHub Flavored Markdown과 admonition 구문을 사용하여 가독성과 시각적 계층 구조를 향상시킵니다. 불필요한 섹션과 과도한 이모지를 피하면서 세부 사항과 간결함의 균형을 유지합니다.

npx skills add https://github.com/github/awesome-copilot --skill create-readme
ZIP 다운로드GitHub
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.

github의 다른 스킬

console-rendering
github
Go에서 struct 태그 기반 콘솔 렌더링 시스템 사용 지침
official
github-pr-query
github
jq 인수 지원을 통해 GitHub 풀 리퀘스트를 효율적으로 조회합니다.
official
jqschema
github
JSON 데이터에서 구조와 타입 정보를 추출하는 JSON 스키마 발견 유틸리티
official
gh-agent-session
github
GitHub CLI 에이전트 세션 확장 기능
official
gh-agent-task
github
GitHub CLI 에이전트 작업 확장
official
github-copilot-agent-tips-and-tricks
github
GitHub Copilot Agent PR 작업을 위한 팁과 요령
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
어떤 저장소든 AI에 대비하도록 만듭니다 — 코드베이스를 분석하고 AGENTS.md, copilot-instructions.md, CI 워크플로우, 이슈 템플릿 등을 생성합니다. PR 리뷰를 분석합니다…
official