Chart.js/docs/developers/contributing.md

Contributing

New contributions to the library are welcome, but we ask that you please follow these guidelines:

• Use tabs for indentation, not spaces.
• Only change the individual files in /src.
• Check that your code will pass eslint code standards, gulp lint will run this for you.
• Check that your code will pass tests, gulp test will run tests for you.
• 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 plugin would be more appropriate.

Building and Testing

Chart.js uses gulp to build the library into a single JavaScript file.

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:

> npm install
> npm install -g gulp

This will install the local development dependencies for Chart.js, along with a CLI for the JavaScript task runner gulp.

The following commands are now available from the repository root:

> 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

More information can be found in gulpfile.js.

Bugs and Issues

Please report these on the GitHub page - at github.com/chartjs/Chart.js. If you could include a link to a simple jsbin or similar to demonstrate the issue, that'd be really helpful.