Skip to content

DEVELOPER.md

Latest commit

 

History

History
66 lines (43 loc) · 1.24 KB

DEVELOPER.md

File metadata and controls

66 lines (43 loc) · 1.24 KB

Developer

Environment Dependencies

  • yarn ^1.12.1
  • git
  • bash
  • node 10

Development

Install dependencies

yarn install

To run the build:

yarn build

To run the build in watch mode:

yarn build-watch

To run tests:

yarn test

To run tests in watch mode:

yarn test-watch

To lint the build:

yarn lint

To update the documentation from the source code:

yarn docs

Debugging

If you are using VSCode, you can debug tests by running the "Jest All" or "Jest Current File" commands in the debug menu. Also, if you are using the 'orta.vscode-jest' plugin, you can debug tests inline using the '>Jest: Start Runner' command.

Commits

This project uses conventional changelog and commitizen. These libraries help us build changelogs, and adhere to semantic versioning conventions. When you are ready to commit, stage your changes and then use the following command:

yarn commit

If you prefer to use regular git just make sure your commits follow the conventional changelog pattern. We use a git post-commit hooks to guarantee the commit follows the correct pattern.