貢献
ライブラリへの新しい貢献は大歓迎ですが、以下のガイドラインに従ってください。
- インデントにはスペースではなく、タブを使用します。
/src
内の個々のファイルのみを変更します。- あなたのコードが
eslint
コード標準に従っていることを確認します。gulp lint
で確認します。 - あなたのコードがテストを通ることを確認します。
gulp test
がテストを実行します。 - プルリクエストは簡潔に保ち、関連する
.md
ファイルに新しい機能の説明を記述します。 - あなたの変更がすべてのユーザに役立つか、あるいはChart.js プラグインを作成する方が適切かどうかを検討してください。
- まもなくリリースされる予定のメジャーリリース(頻繁にはなされません)がない限り、変更を破棄しないでください。私たちは最新の高度な機能の場合にはプラグインを書くことを奨励しています。後方互換性には気を配ってください。
プロジェクトに参加する
活動中のコミッターとコントリビューターは、自己紹介と、このプロジェクトへのコミットアクセス権の要求をしてください。私たちは非常に活動的なSlackコミュニティを持っています。ここから参加できます。あなたが役に立ちたいと思うなら、喜んで受け入れます!
ビルドとテスト
Chart.jsは、gulp を使用して、ライブラリを単一のJavaScriptファイルに構築します。
まず、開発の依存関係を確実にインストールする必要があります。 nodeとnpmをインストールして、Chart.jsリポジトリをローカルディレクトリに複製し、コマンドラインでそのディレクトリに移動した後、次のコマンドを実行します:
> npm install
> npm install -g gulp
これにより、Chart.jsのローカル開発依存関係が、JavaScriptタスクランナー gulp のCLIとともにインストールされます。
リポジトリのルートから以下のコマンドを利用できるようになります。
> gulp build // build Chart.js in ./dist
> gulp unittest // run tests from ./test/specs
> gulp unittest --watch // run tests and watch for source changes
> gulp unittest --coverage // run tests and generate coverage reports in ./coverage
> gulp lint // perform code linting (ESLint)
> gulp test // perform code linting and run unit tests
> gulp docs // build the documentation in ./dist/docs
詳細については、gulpfile.jsを参照してください。
バグとイシュー
バグとイシュー(issue)は、GitHubページ( github.com/chartjs/Chart.js )で報告してください。
サポート要求にイシューを使用しないでください。 Chart.jsの使用についての質問は、Stack Overflowのchartjs
タグをご覧ください。
うまく構造化された詳細なバグレポートは、プロジェクトにとって非常に貴重です。
バグ報告のためのガイドライン:
- Issueを検索して既報かどうかを確認します。
- 問題を簡単なテストケースに切り分けます。
- ウェブサイト上で実行できるバグのデモを含めるようにしてください。例えば、次のツールを使用してください。JS Binまたは、JS Fiddle、Codepen。 (テンプレート)
もし、パグが、ブラウザや画面の密度に依存しているとか、特定の設定やデータでのみ発生する場合などは、詳細も追加で提供してください。