この記事は、主に初心者とGitHubで最初のプロジェクトを公開しようとしている人を対象としています。 プロジェクトをすでに公開している人は、有用なことを学び、コメントにベストプラクティスを書くこともできます。 この記事では、GitHubプロジェクトを改善するための5つの簡単なヒントを提供します。

1.適切なReadmeを作成する

これが最も重要なヒントです！ Readmeファイルは、GitHub上のプロジェクトの顔であり、ユーザーがプロジェクトをどのように見るかです。 説明のないプロジェクトをどのくらいの頻度で見ましたか？ そのようなプロジェクトについてどう思いましたか？ 高い確率で、readmeファイルが空の場合、誰もコードを見ることはありません。 スリーブを通してプロジェクトの説明を参照しないでください。 プログラマーとしてのキャリアのごく初期の段階でのみ、プロジェクトの説明を自分で書くと想像してください。 誰でも理解できるように書いてください。

私の意見では、良いreadmeは次の点で構成されています。

• プロジェクトの説明を1つの文で記述し、プロジェクトの目的を明確にする必要があります。
• プロジェクトのインストール方法。ここでは、NuGetへのリンク、またはソースからプロジェクトをアセンブルする方法の説明を示します。
• プロジェクトでの作業の例。 詳細なコメント付きの単体テストで対応します。
• よくある質問とそれらを解決する方法。 プロジェクトでの作業中に既に遭遇した問題について教えてください。
• ライセンスと感謝。

プロジェクトの説明で絵文字を使用してください。

2. NuGetパッケージを作成する

NuGetを使用すると、プロジェクトでのユーザーの作業が大幅に促進されます。次のように書くだけで十分です。

PM> Install-Package %YOUR_PACKAGE_NAME%
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ソースからビルドする代わりに。 NuGetパッケージエクスプローラーユーティリティを使用して、NuGetパッケージを作成できます。 微調整を行うには、コンソールユーティリティnuget



を使用することをお勧めします（詳細な説明はこちらをご覧ください ）。 readmeからパッケージの説明を正直にコピーできます。 projectUrl



にGitHubへのリンクを含めることを忘れないでください。 パッケージの公開は戦いの半分に過ぎず、最新の状態に保つ必要があります。 これについては、次のヒントで説明します。

3.プロジェクトの自動ビルドと単体テストの実行を追加する

自動化されたアセンブリとテストの実行により、プロジェクトのサポートが簡単になります。 そのような機能を提供する多くのサービスがあります。 オープンソースプロジェクトでは無料なので、appveyorを使用します。 GitHubリポジトリを指定するだけで十分で、90％の確率ですべてがすぐに動作します。 .nu​​specファイルへのappveyorパスとapiKeyを指定することにより、ビルドが成功するたびにプロジェクトをNuGetで自動的に公開します（追加の構成情報はこちらにあります ）。

4.バッジを追加する

このヒントはオプションです。もちろん、バッジなしでも実行できます。 しかし、プロジェクトに関するすべての重要な情報を最初の行に表示すると便利です。

appveyorからプロジェクトの最後のビルドのステータスのバッジを取得できます。 NuGetプロジェクトの最新バージョンのバッジは、 ここから入手できます 。 インターネットでは、.Netフレームワークのバージョン、NuGetプロジェクトのダウンロード数など、あらゆる場面で多数のバッジがあります。

5.コミュニティの時間を作る

最後になりましたが、プロジェクトの周りに形成されるコミュニティに時間を割いてください。 オープンソースでプロジェクトを公開することにより、あなたは自動的にそのサポートに対して責任を負います。 質問に答え、ドキュメントを補足し、プロジェクトを開発します。

ご清聴ありがとうございました！ コメントであなたの役に立つヒントを見てうれしいです。一緒に.Netオープンソースコミュニティを発展させましょう。