Tools for Apache Cordova のサンプルとドキュメントのご紹介


本記事は、マイクロソフト本社の The Visual Studio Blog の記事を抄訳したものです。
【元記事】 Tools for Apache Cordova – Samples and Docs  2015/06/01 9:00 AM

近年、オープン ソース コードの活用は多くの開発者にとって当たり前のようになっています。そして当然のことながら、ドキュメントもオープン化が進んでいます。Azure (英語) から TypeScript (英語) に至るまで、各製品のサンプルやチュートリアル、「ヒントとテクニック集」の共有に公開リポジトリがよく使用され、だれもがコミュニティメンバーとして学習したり、投稿したりすることができる場として広がっています。Visual Studio クライアント ツール チームも、Cordova のドキュメントを手始めにこの流れに乗ろうと考えました。GitHub リポジトリで Cordova のサンプル (英語)チュートリアルとヒントやテクニック (英語) を公開していますので、どうぞご活用ください。

clip_image001

これらは、MSDN で既に公開されている Cordova のドキュメントに代わるものではなく、既存のドキュメントを補完し、皆様がコミュニティに投稿したり、コメントを書き込んだり、学習したりする場として提供されます。この記事では、ドキュメントのオープン化により提供されるものと、コミュニティへの投稿方法について説明します。

Cordova のサンプル

cordova-samples リポジトリ (英語) のルート ディレクトリには、サンプル全体に共通のドキュメント (ライセンス、Readme、投稿情報など) が格納されています。各サンプル アプリは、リポジトリのルート ディレクトリの下にあるサブディレクトリに分けて格納されています。それぞれのサンプルアプリ ディレクトリは、下図のような構造となっています。

clip_image002

Readme ファイルには、アプリが実装する機能やその使用方法、依存関係など、サンプル アプリの内容を理解し実行するために必要な重要情報がすべて記載されています。また、サンプルアプリ ディレクトリのルートに格納されている *.sln ファイルをダブルクリックすると、Visual Studio 2015 でプロジェクトを開くことができます。サンプル アプリにも Visual Studio プロジェクト ファイルが含まれていますが、そのプロジェクトは Cordova CLI のプロジェクト構造と完全な互換性があり、Visual Studio 以外でも使用できます。

サンプル アプリで何らかの問題が発生した場合や新たなご提案がある場合は、イシュー (英語) を開いていただきますようお願いいたします。また可能であれば、プル リクエスト (英語) をお送りください。GitHub でプルリクエストを作成する方法については、こちらのページ (英語) をご覧ください。プロジェクトへの投稿方法の詳細については、CONTRIBUTING.md ファイル (英語) をご確認ください。

Cordova のドキュメント、チュートリアル、ヒントと問題回避策

MSDN のほかに、GitHub でも Cordova の補足的なドキュメント (英語) を公開します。Cordova のサンプルアプリのディレクトリと同様に、ドキュメント リポジトリのルートに Readme ファイルが格納されており、チュートリアルやヒント、問題の回避策などの一覧が記載されています。各チュートリアルは、これもサンプルアプリの場合と同様に、それぞれのサブディレクトリに格納されています。すべてのドキュメントは正規の Markdown ファイル (英語) として記述されているため、だれでも簡単かつ手軽に新しいコンテンツを投稿することができます。

clip_image003

ドキュメントに何らかの問題があった場合や新たなご提案がある場合は、イシュー (英語) を開いてください。可能であれば、プル リクエスト (英語) をお送りいただけますと幸いです (GitHub でプル リクエストを作成する方法については、こちらのページ (英語) をご覧ください)。また、CONTRIBUTING.md ファイル (英語) にはプロジェクトへの投稿方法が詳細に記載されていますので、こちらもご確認ください。

コミュニティでの共有、投稿、学習のお願い

サンプルやドキュメントのオープン ソース化の取り組みはまだ始まったばかりで、やるべきことはまだたくさん残っています。Cordova の開発者コミュニティを活性化し、サンプルやドキュメントを充実させて皆様にご活用いただけるように、この取り組みへの参加、ご協力をお願いいたします。

ぜひサンプルやドキュメントをご利用いただき、ご意見をお寄せください。UserVoice (英語)Send-a-Smile (英語)Twitter (英語)StackOverflow (英語)、またはメールから直接、製品チームにご連絡いただけます。

Visual Studio をまだお使いでない方は、VS Enterprise 2015 RC (他の言語やエディションはこちら) から入手し、ぜひお試しください。セットアップの際には、[Tools for Apache Cordova] チェックボックスを必ずオンにしてください。

皆様の開発のお役に立てますと幸いです。

image

Ali Satter、Visual Studio クライアントツール チーム、プログラム マネージャー
@cpsloal

Ali Satter は、Visual Studio クライアント ツール チームで Visual Studio における Cordova の開発者エクスペリエンスの強化に取り組んでいます。

Comments (0)

Skip to main content