You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developers/contributing.md
+14-13Lines changed: 14 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ New contributions to the library are welcome, but we ask that you please follow
4
4
5
5
- Use tabs for indentation, not spaces.
6
6
- 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.
9
9
- Keep pull requests concise, and document new functionality in the relevant `.md` file.
10
10
- Consider whether your changes are useful for all users, or if creating a Chart.js [plugin](plugins.md) would be more appropriate.
11
11
- 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
22
22
23
23
```bash
24
24
> npm install
25
+
> npm install -g gulp-cli
25
26
```
26
27
27
-
This will install the local development dependencies for Chart.js including a CLI for the JavaScript task runner <ahref="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 <ahref="https://gulpjs.com/"target="_blank">gulp</a>.
28
29
29
30
The following commands are now available from the repository root:
30
31
31
32
```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 forsource 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 forsource 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
41
42
```
42
43
43
44
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:
54
55
- Isolate the problem to a simple test case
55
56
- 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))
56
57
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.
0 commit comments