CONTRIBUTING.md

Thanks in advance for contributing to MapillaryJS. Please follow the conventions below when submitting an issue or pull request.

Preparing your Development Environment

Linux

Install GNU Make and git:

sudo apt-get update &&
sudo apt-get install build-essential git

Install node.js 8.x and npm according to the node.js package manager installation instructions.

Clone a copy of the repo:

git clone https://github.com/mapillary/mapillary-js.git

Change to the mapillary-js directory and install node module dependencies:

cd mapillary-js &&
npm install

OSX

Install the Command Line Tools for Xcode:

xcode-select --install

Install Homebrew according to the instructions.

Install node.js:

brew install node

Clone a copy of the repo:

git clone https://github.com/mapillary/mapillary-js.git

Change to the mapillary-js directory and install node module dependencies:

cd mapillary-js &&
npm install

Serving the Debug Page

npm start

Open the debug page at http://localhost:3000.

Creating a Standalone Build

A standalone build allows you to turn the MapillaryJS repository content into files that can be included on an html page.

To create a standalone build, run

npm prepare

Once that command finishes, you will have a standalone build at dist/mapillary.min.js and dist/mapillary.min.css together with the the dist/*.svg files.

Running Tests

npm test

Building and serving the docs

npm run build-docs &&
python -m SimpleHTTPServer

Open the docs page at http://localhost:8000/docs.

Commit conventions

We use the standardized commit messages according to Conventional Commits with the additional types in the Angular convention.

Version Control Conventions

We use rebase merging (as opposed to basic merging) to merge branches.