CONTRIBUTING.md

Contributing to deck.gl

Thanks for taking the time to contribute!

PRs and bug reports are welcome, and we are actively looking for new maintainers.

Setting Up Dev Environment

The master branch is the active development branch.

Building deck.gl locally from the source requires node.js >=10. Further limitations on the Node version may be imposed by puppeteer and headless-gl. We use yarn to manage the dependencies of deck.gl.

git checkout master
yarn bootstrap
yarn test

Run the layer browser application:

cd examples/layer-browser
yarn
yarn start-local

If you consider opening a PR, here is some documentation to get you started:

• vis.gl developer process
• deck.gl API design guidelines

Community Governance

vis.gl is part of the Urban Computing Foundation. See the organization's Technical Charter.

Technical Steering Committee

deck.gl development is governed by the vis.gl Technical Steering Committee (TSC). Current members:

• Ib Green
• Xiaoji Chen - chairperson
• Tarek Sherif
• Ravi Akkenapally

Maintainers

• Andrew Duberstein - pydeck, json
• Xintong Xia - layers
• Georgios Karnas - glTF
• Dario D'Amico - ArcGIS
• Jesús Botella - MVT

Maintainers of deck.gl have commit access to this GitHub repository, and take part in the decision making process.

If you are interested in becoming a maintainer, read the governance guidelines.

The vis.gl TSC meets monthly and publishes meeting notes via a mailing list. This mailing list can also be utilized to reach out to the TSC.

Code of Conduct

Please be mindful of and adhere to the Linux Foundation's Code of Conduct when contributing to deck.gl.