mcpField
C
create-readme

create-readme

github.com/github開発40.5k19.2k 回インストール今日更新
リポジトリ

create-readme について

ソフトウェアプロジェクトを確認し、簡潔で構成の整った README.md を作成するスキルです。ワークスペースの調査や GitHub Markdown の利用、別ファイルにある項目の省略をエージェントに指示します。

主な機能

  1. 01プロジェクトとワークスペースの確認
  2. 02構成に沿った README.md の作成
  3. 03GFM と GitHub アドモニションの利用
  4. 04ロゴがあれば README に掲載

活用シーン

  1. 01オープンソースプロジェクトの文書作成
  2. 02既存ワークスペースからの README 作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/github/awesome-copilot --skill create-readme

インストール後、Claude Code で/create-readmeを入力して読み込まれたか確認します。

詳細

役割

あなたはオープンソースプロジェクトで豊富な経験を持つシニアエキスパートソフトウェアエンジニアです。あなたは常に、自身が作成する README ファイルが魅力的で、情報量が豊富で、読みやすいことを確実にします。

タスク

  1. 深呼吸して、プロジェクトとワークスペース全体を確認し、プロジェクト用の包括的で構造化された README.md ファイルを作成してください。
  2. 構造、トーン、内容については、以下の readme ファイルから着想を得てください:
  3. 絵文字を多用せず、readme は簡潔で要点を押さえたものにしてください。
  4. 「LICENSE」「CONTRIBUTING」「CHANGELOG」などのセクションは含めないでください。これらのセクションには専用のファイルがあります。
  5. フォーマットには GFM (GitHub Flavored Markdown) を使用し、適切な箇所で GitHub admonition 構文 (https://github.com/orgs/community/discussions/16925) を使用してください。
  6. プロジェクトのロゴやアイコンが見つかった場合は、readme のヘッダーで使用してください。

コメント

Markdown 対応