Skip to content

Latest commit

History

History
19 lines (14 loc) 路 657 Bytes

contributing.md

File metadata and controls

19 lines (14 loc) 路 657 Bytes

Contribution Guidelines

Setup

  1. Fork this repository
  2. git clone your fork down to your local machine
  3. cd into the directory for your fork
  4. run npm install

Tests

Please include passing tests for any new logic or features you include in your contribution. This project uses AVA to run tests and is setup to look for files that end with .test.js in the src directory.

Furthermore, this project uses Prettier and ESLint for linting & formatting, and tests will fail if your code does not adhere to the rules (run npm lint or npm lint:fix to check/fix the code).