Skip to content

Commit 14a934b

Browse files
committed
update contributing info about node/npm versions
1 parent a859456 commit 14a934b

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Before opening a pull request, developer should:
1616

1717
- `git rebase` their local branch off the latest `master`,
1818
- make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on version bumps),
19+
- make sure to commit changes to the `package-lock.json` file (if any),
1920
- write an overview of what the PR attempts to do,
2021
- select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
2122

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,14 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
3434
#### Prerequisites
3535

3636
- git
37-
- [node.js](https://nodejs.org/en/). We recommend using node.js v6.x or v4.x (both LTS).
38-
Upgrading and managing node versions can be easily done using
39-
[`nvm`](https://github.com/creationix/nvm) or its Windows alternatives.
37+
- [node.js](https://nodejs.org/en/). We recommend using node.js v8.x, but all
38+
versions starting from v4 should work. Upgrading and managing node versions
39+
can be easily done using [`nvm`](https://github.com/creationix/nvm) or its
40+
Windows alternatives.
41+
- [`npm`](https://www.npmjs.com/) v5.x and up (which ships by default with
42+
node.js v8.x) to ensure that the
43+
[`package-lock.json`](https://docs.npmjs.com/files/package-lock.json) file is
44+
used and updated correctly.
4045

4146
#### Step 1: Clone the plotly.js repo and install its dependencies
4247

0 commit comments

Comments
 (0)