mirror of
https://github.com/chartjs/Chart.js.git
synced 2025-12-08 20:36:08 +00:00
e3f3b8978b
Coverage data are now generated by running `gulp unittest` with the `--coverage` argument: unit tests are then executed a single time on Travis. The gulp `coverage` task has been removed and `karma.coverage.conf.ci.js` merged into `karma.conf.ci.js`. Update documentation with gulp commands (and remove them from `README.md`) and remove unused `config.jshintrc` (oversight from #3256). Delete `thankyou.md` which has been merged into `README.md`.
43 lines
2.1 KiB
Markdown
43 lines
2.1 KiB
Markdown
# 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 <a href="http://gulpjs.com/" target="_blank">gulp</a> 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:
|
|
|
|
```bash
|
|
> 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 <a href="http://gulpjs.com/" target="_blank">gulp</a>.
|
|
|
|
The following commands are now available from the repository root:
|
|
|
|
```bash
|
|
> 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](https://github.com/chartjs/Chart.js/blob/master/gulpfile.js).
|
|
|
|
# Bugs and Issues
|
|
|
|
Please report these on the GitHub page - at <a href="https://github.com/chartjs/Chart.js" target="_blank">github.com/chartjs/Chart.js</a>. If you could include a link to a simple <a href="http://jsbin.com/" target="_blank">jsbin</a> or similar to demonstrate the issue, that'd be really helpful.
|
|
|