Hi, and thanks in advance for contributing to Mapbox GL. Here's how we work. Please follow these conventions when submitting an issue or pull request.
Install the Xcode Command Line Tools Package
xcode-select --install
Install node.js version 4 or greater
brew install node
Install yarn
brew install yarn
Clone the repository
git clone [email protected]:mapbox/mapbox-gl-js.git
Install node module dependencies
cd mapbox-gl-js &&
yarn install
Install git, node.js (version 6 or greater), GNU Make, and libglew-dev
sudo apt-get update &&
sudo apt-get install build-essential git nodejs libglew-dev libxi-dev
Install yarn
curl -o- -L https://yarnpkg.com/install.sh | bash
(It is also possible to install yarn from Debian/Ubuntu packages. See yarn's install instructions).
Clone the repository
git clone [email protected]:mapbox/mapbox-gl-js.git
Install node module dependencies
cd mapbox-gl-js &&
yarn install
Install git, node.js (version 4 or greater), yarn, npm and node-gyp.
Clone the repository
git clone [email protected]:mapbox/mapbox-gl-js.git
Install node module dependencies
cd mapbox-gl-js
yarn install
Install headless-gl dependencies https://github.com/stackgl/headless-gl#windows
copy node_modules/headless-gl/deps/windows/dll/x64/*.dll c:\windows\system32
Start the debug server
MAPBOX_ACCESS_TOKEN={YOUR MAPBOX ACCESS TOKEN} yarn run start-debug
Open the debug page at http://localhost:9966/debug
A standalone build allows you to turn the contents of this repository into mapbox-gl.js
and mapbox-gl.css
files that can be included on an html page.
To create a standalone build, run
yarn run build-prod-min
yarn run build-css
Once those commands finish, you will have a standalone build at dist/mapbox-gl.js
and dist/mapbox-gl.css
See test/README.md
.
See bench/README.md
.
- We use
error
events to report user errors. - We use
assert
to check invariants that are not likely to be caused by user error. Theseassert
statements are stripped out of production builds. - We use the following ES6 features:
let
/const
for...of
loops (for arraylike iteration only, i.e. what is supported by Bublé'sdangerousForOf
transform)- Arrow functions
- Classes
- Template strings
- Computed and shorthand object properties
- Default parameters
- Rest parameters
- Destructuring
- Modules
- The following ES6 features are not to be used, in order to maintain support for IE 11 and older mobile browsers. This may change in the future.
- Spread (
...
) operator (because it requires Object.assign) - Iterators and generators
- "Library" features such as
Map
,Set
,array.find
, etc.
- Spread (
The conventions for module exports are:
- No exported "namespace objects" -- modules should export either classes or functions, with an occasional exception as needed for stubbing.
- If a module exports something with the same name as the file name (modulo case), it should be the default export.
- Anything else should be a named export.
- We use rebase merging (as opposed to basic merging) to merge branches
See docs/README.md
.
Our labeling system is
- minimalistic: Labels' usefulness are inversely proportional to how many we have.
- objective: Labels should be objective enough that any two people would agree on a labeling decision.
- useful: Labels should track state or capture semantic meaning that would otherwise be hard to search.
We have divided our labels into categories to make them easier to use.
- type (blue)
- actionable status (red)
- non-actionable status (grey)
- importance / urgency (green)
- topic / project / misc (yellow)