リポジトリへの初訪問を有意義にする
リンクを共有する前に、そのプロジェクトを初めて知る人のつもりでリポジトリを開いてみましょう。最初の画面で、解決する問題、対象ユーザー、最短で結果を見る方法を説明します。視覚的なツールならスクリーンショットが役立ちますが、ライブラリなら小さな入出力例の方が有用なことが多いです。
架空の CSV 検証ツールなら、「データベースへ取り込む前に CSV エクスポートを検証する」は「強力なデータツールキット」より具体的です。続けて、不正なファイルのサンプル、検証コマンド、表示されるエラーを示しましょう。
- 長い機能一覧より先に、目的と動くサンプルを載せます。
- 実行環境の要件、インストール手順、既知の制約を明記します。
- ライセンス、ドキュメント、問題の報告先にリンクします。
- 正確なリポジトリトピックを設定し、その分野を探している人が見つけられるようにします。
関心のある最初の読者を見つける
解決対象の問題がすでに話題になっているコミュニティを選びましょう。Python のデータツールとブラウザー向けデザインツールでは、必要な紹介の仕方が異なります。具体的な利用例を一つ説明し、どの点への意見がほしいかを伝えます。自分がメンテナーであることを明かし、投稿ルールを先に読みましょう。
最初の試みは小さく始めます。README を改善し、実行できるサンプルを適切な場所に一つ共有して、寄せられた質問に答えましょう。読者がインストールできないなら、宣伝先を増やす前に修正します。同じリンクを何度投稿しても、使い始める際の問題の解決にはなりません。
役立つものを提供してからスターをお願いする
クイックスタートの後に、「このプロジェクトが役立ったら、また見つけられるようにリポジトリにスターを付けていただけます」と短い任意の案内を添えれば十分です。スターの有無にかかわらず、インストール手順、ドキュメント、サポートを利用できるようにしましょう。
GitHubStart は公開のプロジェクト発見・交流ディレクトリです。GitHubStart にログインせずに公開リポジトリを掲載し、ほかのプロジェクトを閲覧して、応援したいものを選べます。スターを付ける操作は、GitHub にログインしたうえで手動で行います。掲載しても、一定数のスターやお返しのスターが約束されるわけではありません。
毎週の学びを記録する
日付、加えた変更、共有先、寄せられた質問、修正内容を記録しましょう。スターと、インストールの成功、再現可能な問題報告、継続的な貢献などの実用的な指標を比べます。投稿後にスターが急増しても、それは相関関係であり、すべての新しいスターがその投稿から来た証拠ではありません。
例えば、5 人の読者がトークンの設定方法を質問したら、設定手順をサンプルより前へ移します。一般的な公開告知をまた出すのではなく、修正したサンプルをその読者に共有しましょう。
- 1 週目:クリーンな環境でクイックスタートを検証します。
- 2 週目:利用例を一つ共有し、フィードバックに応答します。
- 3 週目:修正を公開し、変更点を説明します。
- 4 週目:有益な対話が生まれた宣伝先を継続し、残りを見直します。
よくある質問
最初の 100 個の GitHub スターを獲得するには?
100 は目標となる節目であり、約束された成果ではありません。使えるプロジェクト、明確な README、関心のある読者から始めましょう。スターが 5 個でも 500 個でも基本は同じです。必要な期間は対象ユーザーとプロジェクトによって変わります。
ログインせずに GitHub リポジトリにスターを付けられますか?
公開リポジトリや GitHubStart は、サイトのアカウントなしで閲覧できます。スターを付けるには、自分で GitHub にログインする必要があります。GitHubStart が代行することはありません。
スターが多いほどユーザーも多いのですか?
必ずしもそうではありません。インストールせず、後で見るために保存する人もいます。利用状況とフィードバックは、スター数と分けて追跡しましょう。