Communitygithub.com

geekjourneyx/readme-generator

GitHub プロジェクト向けにポートフォリオ品質の README.md を生成します。README の作成、最適化、視覚資産の生成などを支援し、プロジェクトのストーリーを効果的に伝えます。

readme-generator とは?

このスキルは、GitHub プロジェクト向けにポートフォリオ品質の README を生成するための専用ツールです。README はプロジェクトの最初の impression であり、機能の羅列ではなく、プロジェクトの価値、背景、使いやすさを簡潔に伝えることが重要だという思想に基づいています。スキルは 6 つのフェーズ(プロジェクト分析、ストーリー抽出、ビジュアル生成方法の選択、アセット生成、README 組み立て、GitHub メタ情報提案)で構成され、各プロジェクトのタイプ(新規作成、既存のアップグレード、ポートフォリオ強化、純粋なドキュメント、UI/製品表示)に応じて最適な戦略を選択します。特に、Codex Image Gen や gpt-image-2 などの画像生成機能を活用して、最大 2 枚の高品質なビジュアルアセット(バナーと特徴図)を生成し、プロジェクトの理解を助けます。出力には、厳格な評価基準(15 秒理解、プロジェクトストーリー、視覚表現など)に基づいた README、MIT ライセンス、GitHub の Description と Topics の推奨、必要に応じて gh CLI による更新提案が含まれます。このスキルは、Claude Code、Codex、Cursor などの AI エージェントと連携し、開発者がプロジェクトのストーリーを効果的に伝える README を作成するのを支援します。

対応✓Claude Code✓Codex CLI~Cursor
npx skills add geekjourneyx/readme-generator

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

プレビュー

スキル README より

License: MIT
readme-generator preview
readme-generator preview

ドキュメント

GitHub README Generator

README はプロジェクトの最初のポートフォリオページです。取扱説明書の目次や機能リストの入れ物ではありません。短い時間で次の 3 つの質問に答える必要があります。

  1. これは何か。
  2. なぜ見る価値があるのか。
  3. どうやって使い始めるのか。

このスキルの目標は、100 点の README 作品 を生成することです。明確で、美的で、抑制が効き、信頼でき、プロジェクトが完全な作品として理解されるようにします。


第一原理

README は信頼の入り口であり、パスへの入り口です。完全なドキュメントではありません。リポジトリを初めて開いた人が素早く判断できるようにする必要があります。

  1. このプロジェクトはどの問題を解決するのか。
  2. 自分に適しているか。
  3. すぐに実行、インストール、または詳細を確認できるか。

1 万スター以上のオープンソースプロジェクトは、通常、情報量で勝つのではなく、明確なファーストビュー、直接的なセットアップパス、信頼できるドキュメントエントリ、そして抑制の効いたコミュニティ情報で勝っています。画像、バッジ、著者情報、デザイン思想はすべて補助的なものです。それらが理解を遅らせるなら、ノイズです。

このスキルの核心的なトレードオフ:README はまずプロジェクトを明確に説明し、それから美化します。ビジュアルは理解に奉仕し、理解を代替しません。


作品基準

以下の評価表ですべての出力を制約します。

次元配点判断基準
15 秒理解25ファーストビューでプロジェクト名、価値、対象者がわかる
プロジェクトストーリー20機能を並べるのではなく、背景、動機、結果を伝える
視覚表現20画像が作品のようであり、小さなフローチャートのスクリーンショットではない
クイックスタート15インストールと使用パスが短く、明確で、コピー可能
信頼できる成果物10実際の出力、能力の境界、または結果を示す
抑制とノイズ除去10繰り返し、スローガン、過剰な説明や装飾を排除

90 点未満の README は提供しません。まずノイズを削除し、重点を拡大し、ナラティブを再構成します。

高スター Project のベースライン

デフォルトで以下の構造を高スターのオープンソースプロジェクトから学習します。

  • プロジェクト名 + 一言のバリュープロポジション。
  • 必要最小限のバッジ。ステータス装飾は積み重ねない。
  • クイックスタートまたはドキュメントエントリを前に配置。
  • 例は、導入コストを下げる場合にのみ表示。
  • コントリビューション、コミュニティ、セキュリティ、ライセンスは簡潔かつ明確に。
  • UI / プロダクトプロジェクトはスクリーンショットを配置可能。ライブラリ、SDK、インフラストラクチャプロジェクトは画像少なめまたはなし。

README をデザイン宣言書、完全なマニュアル、機能の壁、ソーシャル名刺、または社内ワークフローレポートにしないでください。


デザイン原則

必須

  • H1 はプロジェクトの正式名でなければならず、すぐ後にバリュープロポジションが続く。
  • README の冒頭でプロジェクトの価値を説明し、その後にインストール詳細を配置する。
  • 画像は一つの重要なポイントのみを表現するが、プロジェクトの名刺機能を担うべき:読者が一目でプロジェクト名とポジションを確認できるようにする。
  • デフォルトで最大 2 枚の画像:1 枚はカバー、もう 1 枚はコア能力または結果図。
  • GitHub は画像を縮小して表示するため、画像内の主要なテキストはポスターサイズでデザインする必要がある。
  • 機能の説明は具体的であるが、誇張しない。結果で説明できるなら、自画自賛しない。
  • 著者とライセンスは簡潔に保ち、ソーシャル名刺の山積みにしない。

回避必須

  • ASCII アートのタイトル。
  • 絵文字で装飾されたタイトルまたは著者テーブル。
  • 「私たちはプロフェッショナルです」という長大な空文。
  • 1 枚の画像に 6 つ以上の小さなカードを詰め込む。
  • ステージ、コマンド、小さなテキストで埋め尽くされたフローチャート。
  • 3 枚目のフローチャートをデフォルトの成果物とする。ワークフローは通常、本文で説明する方が明確。
  • Image Gen を長文レイアウトツールとして使用する。
  • README を完全な製品マニュアルとして記述する。詳細なドキュメントは docs/ に配置する。

全体フロー

Phase 0    プロジェクトの読み取りとパターン認識
Phase 1    プロジェクトストーリーの抽出
Phase 2    ビジュアル生成方法の選択
Phase 3    作品品質のビジュアルアセット生成
Phase 4    README の組み立て
Phase 5    GitHub メタ情報の提案
Phase 6    検証と提供

Phase 0: プロジェクトの読み取りとパターン認識

まずプロジェクトを読み取り、テンプレートを直接書き始めない。

確認:

ls
find . -maxdepth 2 -type f | sed 's#^\./##' | sort | head -80

優先して読み取る:

  • README.md
  • package.json / pyproject.toml / go.mod / Cargo.toml
  • docs/
  • 主要なエントリファイル
  • サンプル、スクリーンショット、デモファイル

シナリオとビジュアル予算を判断:

シナリオ判断方法戦略画像上限
新規 READMEREADME がない、または README が非常に短い完全に生成するが、短いパスを維持1-2
README アップグレード既存の README があり、有効なコンテンツがあるユニークなコンテンツを保持し、構造とファーストビューを書き直す0-2
ポートフォリオ強化ユーザーが美学、ストーリー、表示を強調ナラティブとカバー表現を優先2
純粋ドキュメントモードSDK、ライブラリ、バックエンドツール、インフラストラクチャ画像は少なめ、インストール、API、ドキュメントエントリを重視0-1
UI / プロダクト表示インターフェース、スクリーンショット、デモ、ビジュアル結果がある実際の結果またはカバーで理解を補助1-2

既存の README をアップグレードする場合、ユーザーの既存の重要なコンテンツを削除しないでください。まず保持可能なコンテンツを抽出し、その後再配置します。

ノイズ除去レビュー

README を書く前に、どのコンテンツを外部に移動または削除するかをマークします。

コンテンツデフォルト処理
デザイン評価表、作業原則、内部方法論SKILL.md または docs/ に配置し、README には入れない
生成されたファイルツリー、テンプレート変数、スクリプト詳細ユーザーが開発ドキュメントを必要とする場合のみ保持
3 枚目のフローチャート削除し、2-4 行の本文または短いリストに置き換える
過剰なソーシャルリンクGitHub / ホームページなどのコアエントリのみ残す
曖昧すぎる機能リスト3 つの結果指向の能力に統合
インストール前の長い背景説明短縮し、クイックスタートを前に移動

Phase 1: プロジェクトストーリーの抽出

7 つのフィールドを収集または推測します。

フィールド説明
project_nameプロジェクトの正式名称
tagline一言のバリュープロポジション、短く、判断力がある
originプロジェクトが生まれた背景:なぜ必要とされたのか
audience誰が使うのか
promiseユーザーが得られる結果
proof実際の能力、スクリーンショット、出力、サンプル、指標
start最短のセットアップパス

質問しすぎないでください。プロジェクトから推測できるなら直接推測します。ナラティブの正確性に影響する場合のみユーザーに質問します。

推奨ナラティブ構造

プロジェクト名
一言のバリュープロポジション
ビジュアルカバー(プロジェクトタイプに応じて必要か判断)

これは何か
なぜ必要なのか
得られるもの
クイックスタート
サンプルまたは出力
動作方法(本文、デフォルトでは画像を添付しない)
インストール
ライセンス
著者

プロジェクトがツール、ライブラリ、またはインフラストラクチャに偏っている場合、「クイックスタート」を「なぜ必要なのか」の後に移動します。README の順序は、テンプレートの完全性ではなく、読者の行動に奉仕する必要があります。


Phase 2: ビジュアル生成方法の選択

README 画像には 2 つのタイプがあります。

  1. 作品カバー:雰囲気、テーマ、記憶ポイントを伝える。
  2. 構造説明図:ステップ、能力、比較、フローを伝える。

ユーザーの意図に応じてモードを選択します。

モード適用シナリオ画像戦略
portfolioデフォルト推奨。完全な作品感を示す必要があるプロジェクトに適する1 枚のカバー + 1 枚のコア能力図
clean-docSDK、ライブラリ、バックエンドツール、シリアスなインフラストラクチャ0-1 枚の画像。クイックスタートとサンプルを優先
visual-storyAI ツール、デザインツール、独立製品、作品展示最大 2 枚の画像。Codex Image Gen が記憶ポイントを担当
structuredユーザーが明示的に情報図、比較図、フローチャートを要求1-2 枚の HTML/CSS ポスター。テキストの正確性を保証

デフォルトでまずプロジェクトタイプを判断し、無理に portfolio を適用しないでください。ビジュアルアセット生成の優先順位は固定です。

  1. Codex Image Gen Skill:優先的に Codex の組み込み画像生成機能を使用してビジュアルアセットを生成します。
  2. 軽量化:README 表示画像は優先的に WebP に変換し、その後 README 参照パスに書き込みます。
  3. HTML to PNG fallback:Image Gen が使用できない、出力が要件を満たさない、またはユーザーが明示的に構造化された正確なテキストを要求する場合にのみ、HTML/CSS テンプレートのスクリーンショットにフォールバックします。

HTML のスクリーンショットをデフォルトパスにしないでください。信頼できるフォールバックであり、最優先のビジュアル戦略ではありません。


Phase 3: 作品品質のビジュアルアセット生成

デフォルト出力では、2 つの安定したファイル名を使用します。

assets/banner.webp
assets/features.webp

これにより、画像が Codex Image Gen からのものであれ、HTML スクリーンショットのフォールバックであれ、README の参照パスが安定します。

画像の役割

画像目的推奨方法
banner.webpプロジェクト名刺。プロジェクト名、ポジション、記憶ポイントを確立Codex Image Gen 優先
features.webpコア能力、結果、または必要なフローの伝達図Codex Image Gen 優先。テキストが正確な場合は HTML フォールバック

workflow.png または workflow.webp をデフォルトで生成しないでください。ユーザーが明示的にフローチャートを要求した場合、フローコンテンツを features.webp に統合するか、本文に配置し、3 枚目の画像を追加しないでください。

デフォルトビジュアルスタイル

すべての README ビジュアルアセットは、デフォルトで同じスタイルを採用します。

黒背景、ミニマル、シネマティックライティング、ハイコントラスト、大きな余白、低輝度、白/グレー/ウォームゴールドの 3 色、プレミアム雑誌のカバー感。
画面質感:極深黒背景 #050505、紙の粒子、浅い被写界深度、ボリュームフォグ、細いリムライト、部分的なメタリック質感。
品質目標:1 万スターのデザイナーレベルの作品品質。

デザイン制約:

  • 背景は主に #050505 の深黒。
  • 色は白、グレー、ウォームゴールドのみを使用。虹色グラデーション、青紫ネオン、高彩度の装飾色は導入しない。
  • 要素を詰め込むのではなく、大きな余白と部分照明を使用する。
  • 画像には価値の高い少量のテキストを含め、伝達とポジショニングを担い、長い説明はしない。
  • テキストは少ないほど強力:各画像には、読者が README を離れた後も覚えておくべき情報のみを保持する。
  • 段落、コマンド、テーブル、バージョン番号の積み重ね、密集した説明は配置しない。

プロジェクト名刺テキスト戦略

デフォルトでは「プロジェクト名刺型画像」を使用し、純粋な雰囲気画像は使用しません。

画像推奨テキスト上限
banner.webpプロジェクト名 + 一言のポジション + 1-3 の短いラベル英単語 18 語または中国語 28 文字
features.webp2-3 の結果フレーズ。必要に応じて短いタイトルを追加各フレーズ 2-5 語

良いテキストはカバータイトルのようであり、取扱説明書のようではありません。

  • プロジェクト名は明確でなければならず、banner.webp に優先的に配置する。
  • ポジション文は結果を述べ、スローガンは述べない。例:「Portfolio-grade README design for open source projects」。
  • ラベルは検索と記憶価値の最も高い単語のみを配置する。例:「Story」、「Visual」、「Signal」。
  • 中国語も使用可能だが、少なめに。英語のプロジェクト名と短い英語ラベルの方が一般的に安定している。
  • Image Gen がテキストを間違えた場合、もう一度再試行する。それでも正確でない場合、Image Gen のビジュアルベース画像は保持し、HTML/CSS フォールバックで正確なテキストを担う。
  • 「完全 AI 生成」のために、プロジェクト名とポジションの正確性を犠牲にしない。

フォントサイズの下限

1920×1080 でデザインする場合:

要素最小フォントサイズ
メインタイトル92px
中国語メインタイトル80px
大きめのカードタイトル48px
本文説明28px
補助ラベル22px
フッター20px

18px 以下のテキストは使用しないでください。GitHub で拡大縮小された後、読めなくなります。

Codex Image Gen の成果物は、16:9 と十分な鮮明さを維持することのみを要求します。良い画像を無理に 1920×1080 にリサンプリングするために、品質を犠牲にしないでください。README 表示画像は優先的に WebP として保存します。1920×1080 は HTML to PNG フォールバックのテンプレートサイズです。

HTML to PNG フォールバック

Image Gen が使用できない、ユーザーが正確な構造化テキストを要求する、または Image Gen の出力がチェックに合格しない場合にのみ使用します。

node scripts/gen_infographic.mjs /tmp/readme-banner.html assets/banner.png 1920 1080
node scripts/gen_infographic.mjs /tmp/readme-features.html assets/features.png 1920 1080
node scripts/convert_webp_assets.mjs assets/banner.png assets/banner.webp assets/features.png assets/features.webp

テンプレートは以下から取得:

templates/banner.html
templates/features.html

テンプレート変数:

{{PROJECT_NAME}}
{{TAGLINE}}
{{PRIMARY_COLOR}}
{{CATEGORY}}
{{PLATFORM}}
{{LANGUAGE}}
{{VERSION_INFO}}
{{TECH_CARDS}}
{{FEATURE_CARDS}}
{{FEATURE_COUNT}}

カード構造:

  • {{TECH_CARDS}} はカバーの右側に使用し、2-3 項目を推奨。短いラベルと一言の説明のみ配置。
  • {{FEATURE_CARDS}} は 2-3 枚の大きなカードのみ配置。最初のカードに featured を追加可能。
  • ワークフローを表現する必要がある場合、features.webp の 3 つの結果フェーズで対応し、3 枚目の画像は追加しない。

Codex Image Gen / gpt-image-2 方式

デフォルトでは優先的に Codex の組み込み画像生成機能を呼び出します。プロジェクト内に一時的に API スクリプトをハードコードしないでください。

Image Gen に適したコンテンツ:

  • README カバー。
  • プロダクト雰囲気画像。
  • ポートフォリオビジュアル。
  • 抽象概念図。
  • 既存の画像を使用したスタイル拡張。

Image Gen に適さないコンテンツ:

  • 正確なフローチャート。
  • 大量の中国語テキストまたは複数段落の説明。
  • コマンド、バージョン、テーブル。
  • 一字一句正確でなければならない長文または UI 図。

推奨プロンプト構造:

Use case: productivity-visual
Asset type: GitHub README visual asset, 16:9
Project: <project_name>
Story: <origin + promise>
Visual direction: black background, minimalist, cinematic lighting, high contrast, large negative space, low brightness, premium magazine cover
Texture and lighting: #050505 deep black background, subtle paper grain, shallow depth of field, volumetric haze, thin rim light, selective metallic highlights
Palette: white, gray, warm gold only
Composition: one strong visual idea, restrained, spacious, no dense UI
Quality bar: 10k-star designer portfolio quality
Text policy: include only high-value name-card text. Use the exact project name, one short positioning line, and optional 1-3 short labels. No paragraphs, commands, tables, tiny captions, or decorative text.
Avoid: emoji, clutter, fake interface text, tiny labels, generic gradients, bright neon, overdesigned dashboards

Image Gen がサポートされていない、呼び出せない、または出力に誤ったテキスト/スタイルの逸脱がある場合、まずより短いテキストプロンプトで 1 回再試行します。それでも正確でない場合、HTML to PNG フォールバックフローに戻り、正確なテキストを担います。

画像の軽量化

README 表示画像はデフォルトで WebP を使用します。WebP は通常、PNG よりも README の読み込みに適しています。PNG は、HTML スクリーンショットフォールバックの中間成果物、透明画像、またはロスレス保存が必要な場合にのみ使用します。

デフォルトコマンド:

npm run webp

プロジェクトに WebP 変換スクリプトがない場合、優先的に cwebp、sips、または利用可能な軽量ツールを使用します。変換のために重い依存関係を導入しないでください。変換できない場合は PNG を保持し、理由を説明します。

ビジュアルチェック

各画像生成後にチェック:

  • GitHub README の表示幅に縮小しても読める。
  • 1 枚の画像は 1 つの重点のみを伝える。
  • 小さなテキストの積み重ねがない。
  • プロジェクト名とポジション文が一目で見える。
  • 画像内のテキストにスペルミス、文字化け、疑似テキストがない。
  • 過剰な装飾がない。
  • ビジュアルスタイルがプロジェクトストーリーと一致している。
  • Image Gen 画像に誤ったテキストや不要な透かしがない。
  • 圧縮後も画像が鮮明で、目立つバンディング、ノイズによる劣化、テキストのぼやけがない。

Phase 4: README の組み立て

デフォルト構造:

<div align="center">

# プロジェクト名

**一言のバリュープロポジション**

<img src="assets/banner.webp" alt="[プロジェクト名] — [バリュープロポジション]" width="100%">

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

</div>

---

## これは何か

[2-3 文でプロジェクト、背景、結果を説明。]

## なぜ必要なのか

[実際の問題を説明し、アンチパターンのリストは掲載しない。]

## 得られるもの

<img src="assets/features.webp" alt="[3 つのコア能力]" width="100%">

## 動作方法

[2-4 行で動作方法を説明。デフォルトで 3 枚目の画像は配置しない。]

## クイックスタート

[最短の実行可能パス。]

## インストール

[依存関係とインストールコマンド。]

## ライセンス

[MIT](./LICENSE)

## 著者について

[簡潔な著者情報。]

ルール:

  • プロジェクトがステータス表示を本当に必要としない限り、3 つ以上のバッジを配置しない。
  • 画像の後で同じ機能リストを繰り返さない。
  • 「デザイン原則」「プロジェクト構造」「生成コンテンツ」をすべて README に詰め込まない。読者にとって有用な部分のみを残す。
  • デフォルトで 3 枚目のワークフロー画像を配置しない。2 枚の画像で作品感とコア情報を伝えるのに十分。
  • 詳細な説明がある場合、docs/ に配置し、README はエントリとしてのみ機能させる。

Phase 5: GitHub メタ情報の推奨

リポジトリの Description と Topics は、GitHub 検索、Trending の関連付け、AI 検索の引用、および人間による迅速な判断のエントリです。これらは README のコンテンツではないため、README.md に書き込まないでください。最終的な返信で独立した提案としてのみ出力します。

第一原理の目標

  • Description は次の質問に答える:このプロジェクトは誰のためにどのような結果を生み出すのか。
  • Topics は次の質問に答える:このプロジェクトはどの検索バケットに入れられるべきか。
  • 推奨数はシグナルの品質によって決定され、多さを追求しない。高品質の 7-9 個は、通常 20 個を埋め尽くすよりも優れている。
  • Trending / SEO / GEO の 3 つのバランス:ホットな検索語をカバーする一方で、プロジェクトの事実を正確に保ち、AI による引用を容易にする。

Description 生成ルール

3 つの候補を生成し、それぞれにスコアを付けます。

[Verb] [specific outcome] for [audience] — [1-3 precise keywords]

ハードな制約:

  • 英語優先、160 文字以内。
  • 動詞で始める:Design / Generate / Build / Create / Convert / Automate。
  • プロジェクトの最もコアな 2-3 のキーワードを含める。
  • 絵文字、感嘆符、マーケティング形容詞を使用しない。
  • プロジェクトの事実から裏付けられない能力は記述しない。

スコアリング:

次元配点判断
正確性40プロジェクトの実際の能力に忠実か
検索価値25GitHub / Google でよく検索される語をカバーしているか
AI 引用可能性20ChatGPT / Claude / Perplexity に直接理解されるか
抑制の度合い15誇張や無駄な言葉がないか

星評価:

スコア星評価
90-1005 つ星、推奨
80-894 つ星、使用可能だがさらに簡潔にできる
70-793 つ星、代替案としてのみ適切
< 70非推奨

Topics 生成ルール

まず候補プールを構築し、その後最終推奨をフィルタリングします。

候補ソース:

  • プロジェクトタイプ:agent-skill、cli-tool、developer-tools、documentation
  • コア技術:nodejs、playwright、codex、image-generation
  • 応用分野:readme、github-readme、open-source、portfolio
  • 現在のトレンド:AI agent、image generation、developer tooling、documentation automation
  • プロジェクトの実際のファイルと README ナラティブに出現するキーワード

フィルタリングルール:

  • 7-9 個を推奨し、10 個を超えない。プロジェクトが明確に複数の分野にまたがる場合を除く。
  • Topic は小文字で、英字、数字、ハイフンのみを使用。
  • 曖昧すぎる語を削除:software、tool、app、github、project、ai。
  • 重複語を削除:readme と github-readme は共存可能。open-source と opensource は 1 つのみ残す。
  • トレンドを追うために不正確な topic を追加しない。

各 topic に星評価と理由を付けます。

星評価意味
5 つ星強い関連性、高い検索価値、追加すべき
4 つ星関連性があり、発見価値がある、追加可能
3 つ星ある程度の関係があるが、コアではない
2 つ星関連性が弱く、通常は非推奨
1 つ星ノイズ、追加しない

出力形式:

GitHub Description 推奨:

1. ★★★★★ <description>
   理由:...

2. ★★★★☆ <description>
   理由:...

最終推奨:<description>

GitHub Topics 推奨:

追加推奨:
- ★★★★★ github-readme — プロジェクトの用途を正確に記述
- ★★★★★ agent-skill — プロジェクトの形態に適合
- ★★★★☆ image-generation — プロジェクトが Image Gen をサポートする場合に追加

追加非推奨:
- ★★☆☆☆ ai — 曖昧すぎ、検索ノイズが多い
- ★★☆☆☆ github — 曖昧すぎ、分類に役立たない

オプションの gh CLI 更新

ユーザーが gh をインストールしており、現在のディレクトリが Git リポジトリであり、GitHub remote を解決できる場合、Agent が gh repo edit を使用して更新することを提案できます。勝手に更新しないでください。まず実行する内容を示し、ユーザーの確認を待つ必要があります。

確認:

gh --version
git remote -v

提案コマンド形式:

gh repo edit OWNER/REPO \
  --description "<final-description>" \
  --add-topic topic-one \
  --add-topic topic-two \
  --add-topic topic-three

古い Topics を置き換える必要がある場合、まず現在の Topics を読み取り、明確に非推奨の項目のみを削除します。

gh repo view OWNER/REPO --json description,repositoryTopics
gh repo edit OWNER/REPO --remove-topic old-topic --add-topic new-topic

説明:git はリポジトリメタ情報を更新できません

git コマンドは GitHub リポジトリの Description や Topics を変更できません。理由:Description と Topics は GitHub プラットフォームのメタ情報であり、Git リポジトリ内のコミット、ブランチ、タグ、またはリモート設定ではありません。

git remote -v は OWNER/REPO を識別するためにのみ使用でき、メタ情報の更新には使用できません。

gh がない場合、推奨値のみを提供し、ユーザーに GitHub ページで手動更新するよう促します。複雑な代替コマンドは提供しないでください。

これらの推奨を README ファイルに保存しないでください。これらは提供時にユーザーへの操作提案として属するものです。


Phase 6: 検証と提供

提供前に必ず検証:

node --version
npm run showcase
file assets/banner.webp assets/features.webp
git status --short

テンプレートや実際の画像を変更した場合、WebP を再生成し、開いて確認する必要があります。

最終報告では以下のみを明確に述べます。

  • 何を変更したか。
  • 結果はどうだったか。
  • どの検証を実行したか。
  • ユーザーが決定する必要がある点がまだあるか。

実装の詳細や長大なプロセスをユーザーに伝えないでください。

関連スキル