Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.1 KB
Raw

Contributing

  1. Download files via the zip file or using git
  2. To install dependencies:
    npm install
  3. To create a symlink for the command:
    npm link

Source Code Formatter (Prettier)

Please run Prettier command before submitting any code by using the following command: `npx prettier --write .`

npx prettier --write

Linter (ESLint)

Please run ESLint command on changed files before submitting any code by using the following command: `npx eslint {files/directory changed}`

IDE Integration

Prettier and ESLint both have extensions available on visual studio code feel free to use them as the project's config files will be picked up on.

https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

Tests

Test are written in the /test folder. Test are written in jest please do not use another framework. Please write test in one describe block for each function.

Commands

Check test coverage command: `npm run coverage` Run jest test: `npm run test`