Skip to content

Latest commit

 

History

History
94 lines (56 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

94 lines (56 loc) · 4.44 KB
Raw

How to Contribute

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

Code of Conduct

Facebook has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Contribution Prerequisites

  • You have Node installed at v16.16.0+ and Yarn at v1.22.0+.
  • You are familiar with Git.

Sending a Pull Request

We will review your pull request and either merge it, request changes to it, or close it with an explanation. We’ll do our best to provide updates and feedback throughout the process.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from main.
  2. Follow the development workflow to setup your environment.
  3. If you’ve fixed a bug or added code that should be tested, add tests!
  4. Ensure the test suite passes (yarn test) and that your code lints (yarn lint).
  5. If you haven’t already, complete the CLA.

Contributor License Agreement (CLA)

In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you’ve done this for another Facebook open source project, you’re good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.

Complete your CLA here.

Development Workflow

After cloning MapillaryJS, run yarn install to fetch its dependencies.

If you want to use data from the Mapillary platform during development, first you need an account. Then you need to register an application to get a client access token.

Setup your MapillaryJS development environment with the following command:

MAPILLARY_ACCESS_TOKEN="<YOUR_CLIENT_ACCESS_TOKEN>" yarn setup

Then, you can run several commands:

  • yarn lint checks the code style.
  • yarn test runs the complete test suite.
  • yarn test-watch runs an interactive test watcher.
  • yarn build creates a dist folder with the package.
  • yarn start starts a development server and rebuilds on source file changes.
  • yarn clear removes the build output.

We recommend running yarn test to make sure you don’t introduce any regressions as you work on your change.

The easiest way to try your changes is to run yarn start and open the debug page at http://localhost:8000.

However it can be handy to try your build of MapillaryJS in a real project. First, run yarn build. This will produce pre-built bundles in the dist folder.

If you want to try your changes in your existing project, you may use yarn link or copy the dist folder into your app and use them instead of the stable version.

Documentation Workflow

See the documentation README.

Develop with Docker

  1. Install Docker.
  2. Clone the repository.
  3. Build the mapillary-js image:
docker build -t mapillary-js .
  1. Create a mapillary-js container and run it interactively:
docker run -v "$(pwd)":/source/mapillary-js -p 8000:8000 --name mapillary-js-container -it mapillary-js
  1. Stop, start, and attach to the container.

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.

License

By contributing to MapillaryJS, you agree that your contributions will be licensed under its MIT license.