Repo Cleaner
プロジェクトの目的、成果、そして最初の有用なアクションを簡単に見つけられるようにします。アプリケーションの動作を維持しながらリポジトリの表面を改善します。
1. 概要を確立する
- リポジトリ、対象読者、期待される成果、言語、そして監査か実装かを特定します。既に付与された承認を再利用します。
- 該当する指示、README、リンクされたガイド、ライセンス、パッケージ/スキルマニフェスト、例、アセット、現在のGitHubメタデータを読みます。主張やコマンドを検証するためにのみ、ソースを必要に応じて検査します。
- ワークツリーを検査し、無関係な変更、既存のライセンス、および帰属表示を保持します。可視性の変更が明示的に許可されていない限り、可視性を変更しないままにします。
- 不足している事実や重要な選択(対象読者、競合するブランディング、利用できないアクセス、不確かなインストール、意味のあるリブランド)について焦点を絞った質問をします。ルーチンのレイアウトの選択はプロジェクトから解決します。待機中は独立して作業を続け、事実を発明して質問を避けないでください。
- 作業用の概要が役立つ場合は assets/repo-brief.md を使用します。これをすべてのターゲットリポジトリに追加しないでください。
2. 読者の経路を監査する
references/audit-and-validation.md を読んでください。発見 → 最初の画面 → 証拠 → インストール → 最初の成功 → より詳しいヘルプ、の流れを追跡します。
最も影響の大きいいくつかのギャップを証拠と優先度とともに列挙します。事実上の問題と好みの選択を分離します。削除すべき乱雑さを含めます。不足している情報と、ツールで利用できない情報を区別します。監査のみの作業の場合は、ファイルや設定を編集せずに、調査結果と具体的な推奨事項を返します。
3. 一貫性のあるプレゼンテーションを構築する
references/readme-and-visuals.md を読んでください。デフォルトはGitHubネイティブのドキュメントスタイル、標準的なフラットバッジ、通常のナビゲーションリンク、プロジェクト固有の証拠とします。依頼がない限り、作者の個人プロフィールの美的感覚を再利用しないでください。構造を選択したり、参考リポジトリから学ぶ場合は references/readme-patterns.md を読んでください。プロジェクトに適した方向性を選択し、理解して使用可能にするための最小限の完全なアセットとドキュメントのセットを実装します。
- 具体的な約束、有用な視覚的証拠、明確な最初のアクションでリードします。重要な情報は実際のテキストとして保持します。
- 有用な場合にのみバナーを追加します。装飾的なブランディングよりも、具体的なタスク、実際の出力、有用なショーケースを優先します。実際の出力からスクリーンショットを取得します。コンセプト、フィクスチャ、再構築、ローカルプレビューを正確にラベル付けします。
- 動作するリンク先と実証された主張を含む、抑制されたバッジ行を追加します。
- READMEには、最短の検証済みインストールおよび使用例を保持します。プラットフォームガイド、トラブルシューティング、例へのリンクは、重複させずに行います。
- アプリケーションソースを移動したり、ランタイム/ビルド動作を変更したりせずに、公開ドキュメントとアセットを整理します。ドキュメントを移動する際はリンクを更新します。
- ドキュメントの深さをプロジェクトに合わせます。一般的なマーケティングコピー、繰り返されるタグライン、強制された機能テーブル、フィラーセクション、バッジウォール、装飾的な図、空のフォルダ階層を削除します。プロジェクト固有のトーンを維持します。
スキルリポジトリの場合、インストール可能なフォルダに SKILL.md と参照されているすべてのリソースが含まれていることを確認します。そのパッケージを公開マーケティングドキュメントから分離します。ホストごとの正確な発見パス、呼び出し例、前提条件、ツール要件を文書化します。各ルートがランタイムテスト済みか、ホストドキュメントに対してチェック済みか、手動でのみ使用可能かを記載します。プレーンなスキルフォルダからプラグイン、マーケットプレイスリスト、またはユニバーサルエージェントサポートを推測しないでください。
4. 真実のメタデータで発見可能性を向上させる
references/github-discovery.md を読んでください。簡潔なAboutテキスト、利用可能な場合は有用な実際のホームページ、証拠に基づいたトピック、ソーシャルプレビューアセットを提案します。適用する前に現在のGitHubの制限を確認します。
適切なツールを使用して承認された設定を適用し、関連する既存の値を保持します。ツールに操作がない場合は、正確な値と設定リンクを準備します。適用済み、準備済み、ブロック済み を分離します。コミットされたメタデータファイルやソーシャルイメージはGitHubを構成しません。承認なしに可視性を変更したり、他者に連絡したり、プロモーションリストを提出したりしないでください。
5. 検証して引き継ぐ
監査リファレンスを使用してリーダーパスを検証します。リンクとアンカー、画像、安全なクイックスタート、真実のバッジと互換性、デスクトップ/モバイル、ライト/ダーク、最終差分、設定の読み返しです。ツールまたはネットワークの制限を明示的に報告します。後日更新が実用的なままになるように、ソースアセットを保存します。
承認された場合のみコミットまたはプッシュし、ターゲットリポジトリのワークフローに従います。宛先と最終リビジョンを確認します。変更、検証、未適用の設定、残っているいくつかのアクションを要約します。トラフィック、スター、ランキング、または未テストのサポートを約束しないでください。