GitHubリポジトリを次のレベルに引き上げよう 🚀️
Eluda (https://dev.to/eludadev)
2022年4月3日に投稿 ・ 2022年7月22日に更新
私は長い間GitHubを使っていますが、その間に最高のGithubリポジトリを作成するためのステップ・バイ・ステップガイドを集めてきました。お気づきのように、この記事はそのガイドの改良版です。
それでは、早速始めてみましょう！
ステップ0. プロジェクトの発見を容易にする 🚀️
— GitHub Docs より。
他の人があなたのプロジェクトを見つけやすくしたり、貢献したりするために、プロジェクトに関連するトピックをリポジトリに追加することができます。
トピックを使えば、特定の主題のリポジトリを探索したり、貢献できるプロジェクトを見つけたり、特定の問題に対する新しい解決策を発見したりすることができます。
最も使用されているトピックを閲覧するには、https://github.com/topics/ にアクセスしてください。
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ1. 記憶に残る名前を選ぶ ✏️
— Forbes より。
プロジェクトにふさわしい名前を見つけることは、成功に大きな影響を与えることがあります。
間違った名前は、使用者との接続を失敗させるだけでなく、明確でインパクトのある名前は、マーケティングやブランディングの努力に非常に役立つことがあります。
以下は、プロジェクトに勝利する名前を思いつくための12の有益な提案です：
- スペルが難しい名前は避ける。
- 徹底的なインターネット検索を行う。
- .devまたは.ioのドメイン名を取得する。
- 何らかの意味を伝える名前を使う。
- 名前に関してフィードバックを得る。
- 名前が声に出して言っても良い響きであるかを確認する。
- 名前をブレーンストーミングするためのリソースを活用する：
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
- リポジトリ: chroline/well_app
- 名前: Well App
- 説明: 😀 たった21日であなたの生産性と長期的な幸福を向上させます。
- リポジトリ: ai/size-limit
- 名前: Size Limit
- 説明: あなたのJavaScriptアプリやライブラリの実行にかかる実際のコストを計算してパフォーマンスを向上させます。制限を超えた場合はプルリクエストでエラーを表示します。
ステップ2. 美しいカバー画像を表示する 🤩️
見栄えが良ければ、多くの人の目にとまるプロジェクトは確かに画像がないものより通常は良い成績を収めます。
ユーザーは、プロフェッショナルさと創造性を感じさせる注目を引くカバー画像があるプロジェクトに、よりサポートする傾向があります。
しかし、プロジェクトの素晴らしいビジュアルを作成するためにデザイナーである必要はありません。インターネット上に質の良い無料のグラフィックデザインツールがたくさんあります：
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ3. バッジを追加して情報を伝える 🔥
多くのパフォーマンスの良いGitHubプロジェクトのトップにある小さな画像に気づいたことがありますか？それらはバッジと呼ばれ、言葉を使わずにより多くの情報を示すために使用されます。
例は次のとおりです：
これらのバッジやその他多くのものは、Shilds.io ウェブサイトで見つけることができます。また、プロジェクト用の新しいバッジをすばやく生成するには Badgen を利用できます！
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ4. 説得力のある説明を書く 📄
— 18F より。
これはプロジェクトを1段落で説明するチャンスです。うまくやれば、読者を引き込んでプロジェクトのもっと多くを探索し、最終的にはそれを使用するように動機付けられます！
一般に、説明は基本的な質問の短いリストに答えるべきです：
- このリポジトリやプロジェクトは何ですか？
- それはどのように機能しますか？
- 誰がこのリポジトリやプロジェクトを使いますか？
- このプロジェクトの目標は何ですか？
これらのステップに従えば、開発者がプロジェクトに関与する方法を知るのが容易になるだけでなく、ノンコーダーもコードが何をするように設計されているか、そして彼らもどのように関与できるかを理解しやすくなります！
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
- リポジトリ: ai/size-limit
- 説明: Size LimitはJavaScriptのパフォーマンス予算ツールです。それはCIの各コミットをチェックし、エンドユーザにとってのJSの実際のコストを計算し、コストが制限を超えるとエラーを投げます。
- リポジトリ: aimeos/aimeos-typo3
- 説明: AimeosはTYPO3のプロフェッショナルでフル機能を備えた高性能なeコマース拡張機能です！既存のTYPO3ウェブサイトに5分でインストールでき、どんなものでも自分のニーズに合わせて調整、拡張、上書き、カスタマイズできます。
ステップ5. ユーザーの目を引くビジュアルを記録する 👀
人々はアニメーション画像が大好きです！GIFを使って視覚的に多くのことを示すことができます：
- あなたのプログラムの使い方。
- あなたのプログラムのベストな特徴。
- 特定のタスクを達成するためのビジュアルガイド。
そして、以下を含む多くの無料ツールがあり、これらを使ってビデオを作成することができます：
- Ascii Cinema あなたのターミナルセッションを記録するために。
- Loom や OBS 画面のどの部分でも記録するために。
- Veed オンラインでビデオを編集するために。
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ6. 詳細なインストールガイドを作成する ✅ (任意)
ユーザーがプログラムを使用する前にそれをインストールする必要がある場合、ユーザーがそれをどのようにするかを説明する詳細なセクションを追加するべきです。一般的なルールには以下のようなものがあります：
- どのステップも飛ばさない。
- 操作システムごとに異なるセクションを持つ（Linux、macOS、Windows）。
- 最も一般的なエラーをどのように修正するかを示す。
HTMLの <details> タグを使って折りたたみメニューを作成することもおすすめします。READMEファイルがずっとクリーンになります！
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ7. 実用的な使用ガイドを作成する 🏁
ユーザーにあなたのソフトウェアをどのように使うか、できれば期待されるアウトプットも一緒に示すべきです。これにより、プログラムの動作についての混乱を防ぎ、ソフトウェアとそのユーザーとの間のより良い結びつきを作り出すのに役立ちます。
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
ステップ8. よくある質問に答える 🤔
このセクション、または 「FAQ」（よくある質問）は、ユーザーが最もよく尋ねる質問を含むように残すべきです。あまりにも多くの人が設定パネルをどこで見つけるか尋ねていますか？ここに答えを置いて、誰も再び尋ねる必要がなくなるようにしてください。
例
👇 あなたのGitHubリポジトリをコメントで共有してください。ここに追加します！
| リポジトリ | FAQ |
|---|---|
| choojs/choo | それはなぜChooと呼ばれていますか？Chooと呼ばれるのは正しいですか？仮想DOMを使いますか？ |
ステップ9. サポート体制のあるコミュニティを築く 🤗
良いコミュニティほど良いものはありません！ユーザーが助けが必要な時に、そこに到達し、質問をし、問題の有益な答えを得ることができます。
あなたのプロジェクトの素晴らしいコミュニティを築くための一般的なステップは以下のとおりです：
ステップ9.1 - つながりましょう！
READMEに「つながりましょう！」セクションを追加し、あなたのコミュニティが存在するプラットフォームへのリンクをいくつか公開してください：Discord、Gitter、Slack、または単にメールアドレスでも。
ステップ9.2 - ディスカッション (任意)
コミュニティが会話を行い、質問や情報交換を行える場所として、リポジトリのGitHubディスカッションを使用できます。
リポジトリでディスカッションを有効にする方法のガイドはこちら。
ステップ9.3 - 行動規範
— GitHub Docs より。
行動規範を採用して、コミュニティの基準を定義し、歓迎され包括的なプロジェクトを示し、虐待を扱う手順を概説します。
行動規範は、コミュニティでの関与の方法を定義します。それは全ての貢献を尊重する包括的な環境を示します。
あなたはリポジトリに CODE_OF_CONDUCT.md ファイルを持っている
こちらの記事はdev.toの良い記事を日本人向けに翻訳しています。
https://dev.to/eludadev/take-your-github-repository-to-the-next-level-17ge
