Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.33 KB

Contributing to worker_map

Contributions are always welcome. To contribute, fork worker_map, commit your changes, & send a pull request.

Feature Requests

Feature requests should be submitted in the issue tracker, with a description of the expected behavior & use case.

Pull Requests

For additions or bug fixes, please modify the relevant files. Include updated unit tests in the test directory as part of your pull request. Unit test files should be named [filename].test.js.

Before running the unit tests you’ll need to install, npm i, development dependencies. Run unit tests from the command-line via npm test.

Coding Guidelines

In addition to the following guidelines, please follow the conventions already established in the code.

  • Spacing:
    Use two spaces for indentation. No tabs.

  • Quotes:
    Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avoid unnecessary escaping.

Guidelines are enforced using ESLint:

$ npm run lint