Contribute
ライブラリへのコントリビュートは大歓迎ですが、 以下のガイドラインに従ってください。
- スペースではなくタブを使って下さい。
/src
内の個々のファイルのみを変更してください。gulp lint
を実行して、コードがeslint
に通ることを確認してください。gulp test
を実行して、コードがテストに合格することを確認してください。- プルリクエストは簡潔にしてください。そして新しい機能を関連する
.md
ファイルに文書化して下さい。 - 変更が全てのユーザーに役に立つか、またはプラグインを作成する方が適切かを検討してください。
- 稀にあるメジャーリリースがない限り、変更を破棄しないでください。 下位互換性については、気をつけなければならない事が沢山あるので、 新規の高度な機能については、プラグインの開発を勧めています。
プロジェクトへの参加
活動中のコミッターや、コントリビューターは、 自由に自己紹介して、プロジェクトのコミット権限をリクエストしてください。 あなたがプロジェクトへ参加するために非常にアクティブなSlackコミュニティがあります。 あなたが協力出来ると思うなら、参加を待っています!
ビルドとテスト
Chart.jsはgulpを使って、 1つJavaScriptファイルを生成します。
まず、開発のdependenciesをインストールする必要があります。 node
とnpm
がインストールされている場合、 Chart.jsのリポジトリをローカルにcloneした後、 コマンドでcloneしたディレクトリに移動して、以下のコマンドを実行します。
$ npm install
$ npm install -g gulp
これでChart.jsの開発のdependenciesと、gulpのCLIがインストールされます。
リポジトリのルートで以下のコマンドが利用可能になります。
$ gulp build // Chart.jsを./dist以下にビルドします。
$ gulp unittest // ./test/specsからテストを実行します。
$ gulp unittest --watch // テストを実行と、ソースの変更をウォッチします。
$ gulp unittest --coverage // テストの実行と、./coverage以下にカバレッジレポートを生成します。
$ gulp lint // ESLintを実行します。
$ gulp test // ESLintを実行し、ユニットテストを実行します。
$ gulp docs // ./dist/docs以下にドキュメントを生成します。
より詳しい情報はgulpfile.jsを参照して下さい。
バグとissue
バグやissueはGitHubのgithub.com/chartjs/Chart.jsで報告してください。 issueはヘルプやサポート目的で使用しないでください。 Chart.jsのヘルプはStack Overflowのchartjs
タグを確認してください。
構造化された詳細なバグレポートは、プロジェクトにとって非常に貴重です。
バグレポートのガイドラインは以下になります。
- issueを検索して、既に報告されているかどうかを確認します。
- 問題をシンプルなテストケースに分離してください。
- 該当のバグのデモを JS Bin、 JS Fiddle、 Codepen等で生成してレポートに含めてください。 (テンプレート)
使用ブラウザや、解像度、特定のデータでのみ発生するか等、 バグに関する詳細もレポートに記載してください。
© 2013 Chart.js is available under the MIT license
このコンテンツはChart.jsドキュメントを翻訳/改変したものです。