contributing.md

Contributing

PRs and bug reports are welcome, and we are actively opening up the deck.gl roadmap to facilitate for external contributors.

Practicalities

Note that once your PR is about to be merged, you will be asked to register as a contributor by filling in a short form.

Process and Guidelines

Developer documentaion is available here. We are ready to prepare additional documentation if requested by contributors.

Developing deck.gl

Node Version Requirement

Running deck.gl as a dependency in another project (e.g. via npm i deck.gl) requires Node 4.x or higher. Building deck.gl from source has a dependency on Node 8.x or higher. Either upgrade to a supported version, or install something like nvm to manage Node versions.

Install yarn

We use yarn to manage packages to install deck.gl

Note: on MacOS it is often convenient to install yarn with brew

brew update
brew install yarn

Setting Up Dev Environment

The master branch is the active development branch.

git checkout master
yarn bootstrap
yarn test

Run the layer browser application:

cd examples/layer-browser
yarn
yarn start-local