Skip to content

Commit

Permalink
Update contribution guidelines per latest development changes (#10792)
Browse files Browse the repository at this point in the history
* Update contribution guidelines per latest
- Fix package.json node engine version to have more explicit error messages
- Add .nvmrc for easier integration with nvm

* Remove extraneous steps

* Use previous version
Locking at CVE-2020-1971 https://nodejs.org/en/blog/release/v14.15.4/

* Use >= to prevent unique version id
  • Loading branch information
karimnaaji authored Jun 21, 2021
1 parent c7e74bf commit 58b7aff
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
14.15.4
14 changes: 6 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Install the Xcode Command Line Tools Package
xcode-select --install
```

Install [node.js](https://nodejs.org/) version ^10.15 ( Minimum 10.15 while sticking only to major version 10.0 )
Install [node.js](https://nodejs.org/) version 14
```bash
brew install node
brew install node@14

This comment has been minimized.

Copy link
@1z2x3c4v5b6n7m8
```
Install [yarn](https://yarnpkg.com/en/)
```bash
Expand All @@ -25,15 +25,15 @@ git clone [email protected]:mapbox/mapbox-gl-js.git

Install node module dependencies
```bash
cd mapbox-gl-js &&
yarn install
```

### Linux

Install [git](https://git-scm.com/), [node.js](https://nodejs.org/) (version ^10.15), [GNU Make](http://www.gnu.org/software/make/), and libglew-dev
Install [git](https://git-scm.com/), [node.js](https://nodejs.org/) version 14, [GNU Make](http://www.gnu.org/software/make/), and libglew-dev

This comment has been minimized.

Copy link
@1z2x3c4v5b6n7m8
```bash
sudo apt-get update &&
sudo apt-get update
curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -
sudo apt-get install build-essential git nodejs libglew-dev libxi-dev
```

Expand All @@ -50,13 +50,12 @@ git clone [email protected]:mapbox/mapbox-gl-js.git

Install node module dependencies
```bash
cd mapbox-gl-js &&
yarn install
```

### Windows

Install [git](https://git-scm.com/), [node.js](https://nodejs.org/) (version ^10.15), [yarn](https://yarnpkg.com/en/docs/install#windows-tab), [npm and node-gyp](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules).
Install [git](https://git-scm.com/), [node.js](https://nodejs.org/) version 14, [yarn](https://yarnpkg.com/en/docs/install#windows-tab), [npm and node-gyp](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules).

Clone the repository
```bash
Expand All @@ -66,7 +65,6 @@ git clone [email protected]:mapbox/mapbox-gl-js.git

Install node module dependencies
```bash
cd mapbox-gl-js
yarn install
```

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"url": "git://github.com/mapbox/mapbox-gl-js.git"
},
"engines": {
"node": ">=6.4.0"
"node": ">=14.15.4"
},
"dependencies": {
"@mapbox/geojson-rewind": "^0.5.0",
Expand Down

0 comments on commit 58b7aff

Please sign in to comment.