){kind=small}
GitHubリポジトリガイドラインを利用して開発者のエクスペリエンスを向上させる
所要時間：1 分
Nexmoでは、開発者コミュニティとコードを共有することが大好きです。通常、これはGitHub上のgitリポジトリに公開することを意味し、そのコードを使いたい開発者は誰でもそうすることができます。
しかし、現在では、いくつかの異なるGitHub組織間で約300のリポジトリがあるため、必要なものを見つけるのが難しく、また、適切な説明がない限り、各プロジェクトの使い方を理解するのが難しいことに気づきました。
デベロッパー・エクスペリエンスをより良いものにするために、私たちは次のようなものを作成（そして公開）しました。 リポジトリ標準.
私たちは、私たちがよく発表する3つのタイプのプロジェクトを認識し、それぞれのタイプに合わせてガイドラインを調整した。
私たちのSDKは最も利用されているリポジトリであり、私たちはそれを誇りに思っています！様々な経験レベルのユーザーがこれらのプロジェクトに参加し、自分のプロジェクトでどのようにSDKを使ってNexmoの特定のタスクを実行できるかを理解する必要があります。私たちは、コミュニティが安心してSDKを構築できるように、インストール手順やライセンスが明確であることに特に注意を払いました。
Nexmoでは多くのデモアプリケーションを公開しています。これらはNexmoの特定の機能をデモするためのスタンドアロンのアプリケーションで、他の人がコピーして使えるようにしています。プロジェクトの機能と目的を明確に示すことは、このようなリポジトリでは本当に重要です。また、ライセンスや、Dockerセットアップや "click to deploy "ボタンを含めることで、ユーザーが私たちが作ったものを試せるようにしました。
どんな種類の標準でも危険なのは、ルールが手に負えなくなることだ！私たちのリポジトリの多くは、チュートリアルやブログ記事、開発者に特定の何かを示すためのビデオを説明するために作成された、単発のスタンドアロン・アプリケーションの公開バージョンにすぎません。
もし、デプロイ可能な機能や詳しい使い方が完璧に説明されているものだけを公開していたら、GitHubアカウントにあるリポジトリはもっと少なくなっていただろう！
実際のところ、ここでの唯一のルールは、リポジトリには、そのリポジトリが支援するものへのリンクを含む READMEを持たなければならないということです。
私たちは、リポジトリを公開する際に重要だと考えていることのチェックリストを共有しようと、リポジトリ・スタンダードを作成しました。誰もがそれぞれの考えを持っていましたが、ほとんどがエンジニアで構成されたチームであるため、コードではないものに関しては、それが必ずしも卓越したものになるとは限りませんでした。
最も一般的な事柄のチェックリストとテンプレートを作成することで、私たちは「正しいことをする」を「簡単なことをする」に変えた。 「簡単なことをする"そして、開発者が GitHub で私たちのプロジェクトを見つける体験を改善しました。
まずは 基本的なREADMEテンプレートを作成し、シンプルな構造を持たせ、開発者向けドキュメントへのリンクと、必要な場合の連絡方法をユーザーに伝えるようにしました。基本的なものですが、何もないよりはずっとマシです。
すべてのリポジトリにはライセンスが必要で、私たちはMITをデフォルトとしています。チェックリストを含むガイドラインがあることで、私たちがそうしたいことを思い出させてくれます。
また、基本的な CONTRIBUTING一般化するのが難しいので不完全ですが、出発点を与えてくれますし、リポジトリ作成者がコードを共有するときの作業を少しだけ減らしてくれます。
ここに書かれていることは小さなことで、完全なガイドラインにはもっとたくさんのことが書かれています。開発者は GitHub リポジトリにたどり着いたものの、何を見つけたのか、次にどこに行けばいいのかわからないかもしれません。自分がどこにいるのか、このリポジトリが何についてのものなのか、そして次にどこへ行く可能性があるのかを示す手助けをすることは、より良いデベロッパーエクスペリエンスのための素晴らしい要素です。