2018-03-17 17:07:55 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2018-04-23 00:08:03 +00:00
< title > Contributing · Chart.js documentation< / title >
2018-03-17 17:07:55 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.2" >
< meta name = "author" content = "chartjs" >
< link rel = "stylesheet" href = "../gitbook/style.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-search-plus/search.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-fontsettings/website.css" >
< link rel = "stylesheet" href = "../style.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "../gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "../gitbook/images/favicon.ico" type = "image/x-icon" >
< link rel = "next" href = "../notes/" / >
< link rel = "prev" href = "axes.html" / >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-chartjs/style.css" >
< script src = "../gitbook/gitbook-plugin-chartjs/Chart.bundle.js" > < / script >
< script src = "../gitbook/gitbook-plugin-chartjs/chartjs-plugin-deferred.js" > < / script >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "chapter " data-level = "1.1" data-path = "../" >
< a href = "../" >
Chart.js
< / a >
< / li >
< li class = "chapter " data-level = "1.2" data-path = "../getting-started/" >
< a href = "../getting-started/" >
Getting Started
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "../getting-started/installation.html" >
< a href = "../getting-started/installation.html" >
Installation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "../getting-started/integration.html" >
< a href = "../getting-started/integration.html" >
Integration
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "../getting-started/usage.html" >
< a href = "../getting-started/usage.html" >
Usage
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" data-path = "../general/" >
< a href = "../general/" >
General
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "../general/responsive.html" >
< a href = "../general/responsive.html" >
Responsive
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.2" data-path = "../general/device-pixel-ratio.html" >
< a href = "../general/device-pixel-ratio.html" >
Pixel Ratio
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "../general/interactions/" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/" >
Interactions
< / a >
< ul class = "articles" >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.3.1" data-path = "../general/interactions/events.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/events.html" >
Events
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.3.2" data-path = "../general/interactions/modes.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/modes.html" >
Modes
< / a >
< / li >
< / ul >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.4" data-path = "../general/options.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/options.html" >
Options
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.5" data-path = "../general/colors.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/colors.html" >
Colors
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.6" data-path = "../general/fonts.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/fonts.html" >
Fonts
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "../configuration/" >
< a href = "../configuration/" >
Configuration
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "../configuration/animations.html" >
< a href = "../configuration/animations.html" >
Animations
< / a >
< / li >
< li class = "chapter " data-level = "1.4.2" data-path = "../configuration/layout.html" >
< a href = "../configuration/layout.html" >
Layout
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "../configuration/legend.html" >
< a href = "../configuration/legend.html" >
Legend
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "../configuration/title.html" >
< a href = "../configuration/title.html" >
Title
< / a >
< / li >
< li class = "chapter " data-level = "1.4.5" data-path = "../configuration/tooltip.html" >
< a href = "../configuration/tooltip.html" >
Tooltip
< / a >
< / li >
< li class = "chapter " data-level = "1.4.6" data-path = "../configuration/elements.html" >
< a href = "../configuration/elements.html" >
Elements
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "../charts/" >
< a href = "../charts/" >
Charts
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "../charts/line.html" >
< a href = "../charts/line.html" >
Line
< / a >
< / li >
< li class = "chapter " data-level = "1.5.2" data-path = "../charts/bar.html" >
< a href = "../charts/bar.html" >
Bar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "../charts/radar.html" >
< a href = "../charts/radar.html" >
Radar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.4" data-path = "../charts/doughnut.html" >
< a href = "../charts/doughnut.html" >
Doughnut & Pie
< / a >
< / li >
< li class = "chapter " data-level = "1.5.5" data-path = "../charts/polar.html" >
< a href = "../charts/polar.html" >
Polar Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.6" data-path = "../charts/bubble.html" >
< a href = "../charts/bubble.html" >
Bubble
< / a >
< / li >
< li class = "chapter " data-level = "1.5.7" data-path = "../charts/scatter.html" >
< a href = "../charts/scatter.html" >
Scatter
< / a >
< / li >
< li class = "chapter " data-level = "1.5.8" data-path = "../charts/area.html" >
< a href = "../charts/area.html" >
Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.9" data-path = "../charts/mixed.html" >
< a href = "../charts/mixed.html" >
Mixed
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6" data-path = "../axes/" >
< a href = "../axes/" >
Axes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1" data-path = "../axes/cartesian/" >
< a href = "../axes/cartesian/" >
Cartesian
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1.1" data-path = "../axes/cartesian/category.html" >
< a href = "../axes/cartesian/category.html" >
Category
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.2" data-path = "../axes/cartesian/linear.html" >
< a href = "../axes/cartesian/linear.html" >
Linear
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.3" data-path = "../axes/cartesian/logarithmic.html" >
< a href = "../axes/cartesian/logarithmic.html" >
Logarithmic
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.4" data-path = "../axes/cartesian/time.html" >
< a href = "../axes/cartesian/time.html" >
Time
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.2" data-path = "../axes/radial/" >
< a href = "../axes/radial/" >
Radial
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.2.1" data-path = "../axes/radial/linear.html" >
< a href = "../axes/radial/linear.html" >
Linear
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.3" data-path = "../axes/labelling.html" >
< a href = "../axes/labelling.html" >
Labelling
< / a >
< / li >
< li class = "chapter " data-level = "1.6.4" data-path = "../axes/styling.html" >
< a href = "../axes/styling.html" >
Styling
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.7" data-path = "./" >
< a href = "./" >
Developers
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.7.1" data-path = "api.html" >
< a href = "api.html" >
Chart.js API
< / a >
< / li >
< li class = "chapter " data-level = "1.7.2" data-path = "updates.html" >
< a href = "updates.html" >
Updating Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.3" data-path = "plugins.html" >
< a href = "plugins.html" >
Plugins
< / a >
< / li >
< li class = "chapter " data-level = "1.7.4" data-path = "charts.html" >
< a href = "charts.html" >
New Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.5" data-path = "axes.html" >
< a href = "axes.html" >
New Axes
< / a >
< / li >
< li class = "chapter active" data-level = "1.7.6" data-path = "contributing.html" >
< a href = "contributing.html" >
Contributing
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.8" data-path = "../notes/" >
< a href = "../notes/" >
Additional Notes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.8.1" data-path = "../notes/comparison.html" >
< a href = "../notes/comparison.html" >
Comparison Table
< / a >
< / li >
< li class = "chapter " data-level = "1.8.2" data-path = "../notes/extensions.html" >
< a href = "../notes/extensions.html" >
Popular Extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.8.3" data-path = "../notes/license.html" >
< a href = "../notes/license.html" >
License
< / a >
< / li >
< / ul >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
< a href = ".." > Contributing< / a >
< / h1 >
< / div >
< div class = "page-wrapper" tabindex = "-1" role = "main" >
< div class = "page-inner" >
< div class = "search-plus" id = "book-search-results" >
< div class = "search-noresults" >
< section class = "normal markdown-section" >
< h1 id = "contributing" > Contributing< / h1 >
< p > New contributions to the library are welcome, but we ask that you please follow these guidelines:< / p >
< ul >
< li > Use tabs for indentation, not spaces.< / li >
< li > Only change the individual files in < code > /src< / code > .< / li >
< li > Check that your code will pass < code > eslint< / code > code standards, < code > gulp lint< / code > will run this for you.< / li >
< li > Check that your code will pass tests, < code > gulp test< / code > will run tests for you.< / li >
< li > Keep pull requests concise, and document new functionality in the relevant < code > .md< / code > file.< / li >
< li > Consider whether your changes are useful for all users, or if creating a Chart.js < a href = "plugins.html" > plugin< / a > would be more appropriate.< / li >
< li > Avoid breaking changes unless there is an upcoming major release, which are infrequent. We encourage people to write plugins for most new advanced features, so care a lot about backwards compatibility.< / li >
< / ul >
< h1 id = "joining-the-project" > Joining the project< / h1 >
2018-04-23 00:08:03 +00:00
< p > Active committers and contributors are invited to introduce yourself and request commit access to this project. We have a very active Slack community that you can join < a href = "https://chartjs-slack.herokuapp.com/" target = "_blank" > here< / a > . If you think you can help, we' d love to have you!< / p >
2018-03-17 17:07:55 +00:00
< h1 id = "building-and-testing" > Building and Testing< / h1 >
< p > Chart.js uses < a href = "http://gulpjs.com/" target = "_blank" > gulp< / a > to build the library into a single JavaScript file.< / p >
< p > Firstly, we need to ensure development dependencies are installed. With node and npm installed, after cloning the Chart.js repo to a local directory, and navigating to that directory in the command line, we can run the following:< / p >
< pre > < code class = "lang-bash" > > npm install
> npm install -g gulp
< / code > < / pre >
< p > This will install the local development dependencies for Chart.js, along with a CLI for the JavaScript task runner < a href = "http://gulpjs.com/" target = "_blank" > gulp< / a > .< / p >
< p > The following commands are now available from the repository root:< / p >
< pre > < code class = "lang-bash" > > gulp build // build Chart.js < span class = "hljs-keyword" > in< / span > ./dist
> gulp unittest // run tests from ./< span class = "hljs-built_in" > test< / span > /specs
> gulp unittest --watch // run tests and watch < span class = "hljs-keyword" > for< / span > < span class = "hljs-built_in" > source< / span > changes
> gulp unittest --coverage // run tests and generate coverage reports < span class = "hljs-keyword" > in< / span > ./coverage
> gulp lint // perform code linting (ESLint)
> gulp < span class = "hljs-built_in" > test< / span > // perform code linting and run unit tests
> gulp docs // build the documentation < span class = "hljs-keyword" > in< / span > ./dist/docs
< / code > < / pre >
< p > More information can be found in < a href = "https://github.com/chartjs/Chart.js/blob/master/gulpfile.js" target = "_blank" > gulpfile.js< / a > .< / p >
< h1 id = "bugs-and-issues" > Bugs and Issues< / h1 >
< p > Please report these on the GitHub page - at < a href = "https://github.com/chartjs/Chart.js" target = "_blank" > github.com/chartjs/Chart.js< / a > . Please do not use issues for support requests. For help using Chart.js, please take a look at the < a href = "http://stackoverflow.com/questions/tagged/chartjs" target = "_blank" > < code > chartjs< / code > < / a > tag on Stack Overflow.< / p >
< p > Well structured, detailed bug reports are hugely valuable for the project.< / p >
< p > Guidelines for reporting bugs:< / p >
< ul >
< li > Check the issue search to see if it has already been reported< / li >
< li > Isolate the problem to a simple test case< / li >
< li > Please include a demonstration of the bug on a website such as < a href = "http://jsbin.com/" target = "_blank" > JS Bin< / a > , < a href = "http://jsfiddle.net/" target = "_blank" > JS Fiddle< / a > , or < a href = "http://codepen.io/pen/" target = "_blank" > Codepen< / a > . (< a href = "http://codepen.io/pen?template=JXVYzq" target = "_blank" > Template< / a > )< / li >
< / ul >
< p > Please provide any additional details associated with the bug, if it' s browser or screen density specific, or only happens with a certain configuration or data.< / p >
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< a href = "axes.html" class = "navigation navigation-prev " aria-label = "Previous page: New Axes" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../notes/" class = "navigation navigation-next " aria-label = "Next page: Additional Notes" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-04-23 00:08:03 +00:00
gitbook.page.hasChanged({"page":{"title":"Contributing","level":"1.7.6","depth":2,"next":{"title":"Additional Notes","level":"1.8","depth":1,"path":"notes/README.md","ref":"notes/README.md","articles":[{"title":"Comparison Table","level":"1.8.1","depth":2,"path":"notes/comparison.md","ref":"notes/comparison.md","articles":[]},{"title":"Popular Extensions","level":"1.8.2","depth":2,"path":"notes/extensions.md","ref":"notes/extensions.md","articles":[]},{"title":"License","level":"1.8.3","depth":2,"path":"notes/license.md","ref":"notes/license.md","articles":[]}]},"previous":{"title":"New Axes","level":"1.7.5","depth":2,"path":"developers/axes.md","ref":"developers/axes.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-lunr","-search","search-plus","anchorjs","chartjs","ga"],"root":"./docs","styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"anchorjs":{"icon":"#","placement":"left","visible":"always"},"ga":{"configuration":"auto","token":"UA-28909194-3"},"theme-default":{"styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"search-plus":{},"chartjs":{"defaults":null},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2}},"theme":"default","author":"chartjs","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Chart.js documentation","gitbook":"3.2.2"},"file":{"path":"developers/contributing.md","mtime":"2018-03-01T21:46:31.679Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-03-01T21:50:47.970Z"},"basePath":"..","book":{"language":""}});
2018-03-17 17:07:55 +00:00
});
< / script >
< / div >
< script src = "../gitbook/gitbook.js" > < / script >
< script src = "../gitbook/theme.js" > < / script >
< script src = "../gitbook/gitbook-plugin-search-plus/jquery.mark.min.js" > < / script >
< script src = "../gitbook/gitbook-plugin-search-plus/search.js" > < / script >
2018-04-23 00:08:03 +00:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" > < / script >
2018-03-17 17:07:55 +00:00
< script src = "../gitbook/gitbook-plugin-anchorjs/anchor-style.js" > < / script >
< script src = "../gitbook/gitbook-plugin-ga/plugin.js" > < / script >
< script src = "../gitbook/gitbook-plugin-sharing/buttons.js" > < / script >
< script src = "../gitbook/gitbook-plugin-fontsettings/fontsettings.js" > < / script >
< / body >
< / html >
