Skip to content
This repository was archived by the owner on Aug 8, 2024. It is now read-only.

Files

Latest commit

 

History

History
55 lines (35 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.32 KB

Minimap.js Contribution Guide

Hi! We are really excited that you are interested in contributing to this repository. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Available scripts

Dev

Starts the development server or runs a demo script (e.g. core project).

Usage

$ npm run dev

Build

Builds static files into the dist folder.

Usage

$ npm run build

Test

Usage

npm run test

A coverage summary is printed out to the console and an HTML report is generated in /coverage/lcov-report/index.html.

Lint

Usage

npm run lint

Pull Requests

  1. Fork the repo.
  2. Create a branch from master.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Run npm run test and ensure the test suite passes.
  6. PRs must be rebased before merge.
  7. PR should be reviewed by at least one maintainer prior to merging.`

You don't need to worry about code style as long as you have installed the dev dependencies – modified files should automatically be formatted with Prettier when committing (via Git Hooks). For committing please run npm run commit and you will get the prompts needed to start a commit.