Skip to content

Commit e35f9f3

Browse files
committed
updated the docs so that only gulp-cli is installed globally
1 parent 7c140c3 commit e35f9f3

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

docs/developers/contributing.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ New contributions to the library are welcome, but we ask that you please follow
44

55
- Use tabs for indentation, not spaces.
66
- Only change the individual files in `/src`.
7-
- Check that your code will pass `eslint` code standards, `npm run gulp lint` will run this for you.
8-
- Check that your code will pass tests, `npm run gulp test` will run tests for you.
7+
- Check that your code will pass `eslint` code standards, `gulp lint` will run this for you.
8+
- Check that your code will pass tests, `gulp test` will run tests for you.
99
- Keep pull requests concise, and document new functionality in the relevant `.md` file.
1010
- Consider whether your changes are useful for all users, or if creating a Chart.js [plugin](plugins.md) would be more appropriate.
1111
- 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.
@@ -22,22 +22,23 @@ Firstly, we need to ensure development dependencies are installed. With node and
2222

2323
```bash
2424
> npm install
25+
> npm install -g gulp-cli
2526
```
2627

27-
This will install the local development dependencies for Chart.js including a CLI for the JavaScript task runner <a href="https://gulpjs.com/" target="_blank">gulp</a>.
28+
This will install the local development dependencies for Chart.js, along with a CLI for the JavaScript task runner <a href="https://gulpjs.com/" target="_blank">gulp</a>.
2829

2930
The following commands are now available from the repository root:
3031

3132
```bash
32-
> npm run gulp build // build dist files in ./dist
33-
> npm run gulp build --watch // build and watch for changes
34-
> npm run gulp unittest // run tests from ./test/specs
35-
> npm run gulp unittest --watch // run tests and watch for source changes
36-
> npm run gulp unittest --coverage // run tests and generate coverage reports in ./coverage
37-
> npm run gulp lint // perform code linting (ESLint)
38-
> npm run gulp test // perform code linting and run unit tests
39-
> npm run gulp docs // build the documentation in ./dist/docs
40-
> npm run gulp docs --watch // starts the gitbook live reloaded server
33+
> gulp build // build dist files in ./dist
34+
> gulp build --watch // build and watch for changes
35+
> gulp unittest // run tests from ./test/specs
36+
> gulp unittest --watch // run tests and watch for source changes
37+
> gulp unittest --coverage // run tests and generate coverage reports in ./coverage
38+
> gulp lint // perform code linting (ESLint)
39+
> gulp test // perform code linting and run unit tests
40+
> gulp docs // build the documentation in ./dist/docs
41+
> gulp docs --watch // starts the gitbook live reloaded server
4142
```
4243

4344
More information can be found in [gulpfile.js](https://github.com/chartjs/Chart.js/blob/master/gulpfile.js).
@@ -54,4 +55,4 @@ Guidelines for reporting bugs:
5455
- Isolate the problem to a simple test case
5556
- Please include a demonstration of the bug on a website such as [JS Bin](https://jsbin.com/), [JS Fiddle](https://jsfiddle.net/), or [Codepen](https://codepen.io/pen/). ([Template](https://codepen.io/pen?template=JXVYzq))
5657

57-
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.
58+
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.

package.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,6 @@
2222
"bugs": {
2323
"url": "https://github.com/chartjs/Chart.js/issues"
2424
},
25-
"scripts": {
26-
"gulp": "gulp",
27-
"start": "npm run gulp build --watch",
28-
"test": "npm run gulp test"
29-
},
3025
"devDependencies": {
3126
"coveralls": "^3.0.0",
3227
"eslint": "^5.9.0",

0 commit comments

Comments
 (0)