Merge pull request #650 from fulldecent/patch-2

[CONTROVERSIAL] Update scope: new chart types are off topic
This commit is contained in:
Nick Downie 2014-12-29 20:42:54 +00:00
commit 932908532c
2 changed files with 12 additions and 1 deletions

View File

@ -5,7 +5,16 @@ New contributions to the library are welcome, just a couple of guidelines:
* Tabs for indentation, not spaces please. * Tabs for indentation, not spaces please.
* Please ensure you're changing the individual files in /src, not the concatenated output in the Chart.js file in the root of the repo. * Please ensure you're changing the individual files in /src, not the concatenated output in the Chart.js file in the root of the repo.
* Please check that your code will pass jshint code standards, gulp jshint will run this for you. * Please check that your code will pass jshint code standards, `gulp jshint` will run this for you.
* Please keep pull requests concise, and document new functionality in the relevant .md file. * Please keep pull requests concise, and document new functionality in the relevant .md file.
* Consider whether your changes are useful for all users, or if creating a Chart.js extension would be more appropriate. * Consider whether your changes are useful for all users, or if creating a Chart.js extension would be more appropriate.
* Please avoid committing in the build Chart.js & Chart.min.js file, as it causes conflicts when merging. * Please avoid committing in the build Chart.js & Chart.min.js file, as it causes conflicts when merging.
New Chart Types
===============
Chart.js is designed to be modular. See http://www.chartjs.org/docs/#advanced-usage-writing-new-chart-types
All discussion of new chart types (horizontal bar charts, X-Y scatter plot, etc.) should be done in the Chart.js Google Group at https://groups.google.com/forum/#!forum/chartjs-user-discussion This will get the most exposure for getting people to help define requirements, complete programming and documentation of your vision.
Please do not request new chart types in the project issues. Fully implemented, documented, and useful new charts may be maintained in a new repository. Later, we may add a link to selected external repositories from this project.

View File

@ -13,3 +13,5 @@ Chart.js is available under the [MIT license](http://opensource.org/licenses/MIT
## Bugs & issues ## Bugs & issues
When reporting bugs or issues, if you could include a link to a simple [jsbin](http://jsbin.com) or similar demonstrating the issue, that'd be really helpful. When reporting bugs or issues, if you could include a link to a simple [jsbin](http://jsbin.com) or similar demonstrating the issue, that'd be really helpful.
This project is modular and supports separately-maintained new chart types. This project's scope includes only the chart types included. New chart types should be created and maintained in separate repositories. We may consider linking to them from this project if they incude passing build tests and have complete documentation. Please discuss new or "missing" chart types in the [Chart.js User Discussion](https://groups.google.com/forum/#!forum/chartjs-user-discussion) Google Group and not in Issues. For more information, please also see the CONTRIBUTING file.