Contributions are welcome, assuming that they align with the general design goals and philosophy of the repo.
Unless you just want to contribute a small bug fix, it is a good idea to start by opening an issue and discuss your idea with the maintainers. This maximizes the chances that your contribution will be accepted once you open a pull request.
To contribute, you will likely want to clone the loaders.gl repository and make sure you can install, build and run tests.
Our primary development environment is MacOS, but it is possible to build loaders.gl on Linux and Windows (using a Linux environment).
It is possible to build under Windows, but not directly in the Windows command prompt. You will need to install a Linux command line environment.
Install WSL (Windows Subsystem for Linux) on Windows 10.
sudo apt update sudo apt install nodejs
sudo apt update sudo apt install yarn nodejs yarn –version
sudo apt-get install jq
On Linux Systems Install packages
To get the headless tests working: export DISPLAY=:99.0; sh -e /etc/init.d/xvfb start
yarn lint: Check coding standards and formatting
yarn lint fix: Fix errors with formatting
yarn test node: Quick test run under Node.js
yarn test browser: Test run under browser, good for interactive debugging
yarn test: Run lint, node test, browser tests (in headless mode)