Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 1.09 KB

Contributing

Please see our community docs on contributing.

This document is for developers or programmers contributing to source code. If you're interested in contributing a different way, please see the link above.

Setup

  • Install Mise
  • Run mise install to install the correct version of node.
  • Run npm install to install the project dependencies.

Testing

Role: contributors wishing to change the project source code

  • Local tests are located in the javascript folder.
  • The in-house global test runner guut is located at javascript/test/globals.js. These are intended to run against the root gurmukhi-utils test folder.
  • The guut global test runner is based off uvu/assert.
  • Run tests by setting the javascript folder as your current working directory in the terminal and then executing npm run test.

Thank you

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project.