Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 1.79 KB

Contributing

Commands

When developing, run the following from the root-level directory:

yarn

Lint code - It will only run lint and not fix

yarn lint

Lint and fix code - It will run lint and fix code

yarn lint:fix

Build Typescript - Will validate and build typescript

yarn lint:ts

Build - This will build all libraries.

yarn build:libs

Test - This will run tests.

yarn test

Test coverage - This will run all tests and report test coverage.

yarn test:cov

Test no coverage - This will run all tests without test coverage.

yarn test:nocov

Coding style

All the JavaScript code in this project conforms to the prettier coding style. Code is automatically prettified upon commit using precommit hooks.

Documentation

Our documentation is using gitbook. If you have been given access as a contributor to the docs, you will have access to this link

Releasing

Semantic release is being used for versioning and packaging purposes.

Make sure commit messages follow the commit git message syntax

All PR's run a CI check that need to pass and require at least 1 approval. Once approved and merged into master.

Semantic release will check the commit history on the approved PR. When the PR is merged into master, it will determine the version based on commit message syntax.

  • The version will be updated for each package.
  • Packages will be published.