Appstage Shared Packages

Prerequisites

To be able to contribute, you need to have account on npmjs and this account needs to have access to @24i organization.

Developing

The yarn install will install root dependencies and bootstrap all subprojects. Then find README in relevant package in packages folder. We have commit hooks which run these linters and tests before the the commit goes through.

To start developing a new feature or bug fix, there is typical flow:

1. create new branch in name form: <type>/<JIRA-ISSUE-KEY>-short_summary
2. commit your changes. Each commit must follow message convention Conventional Commits
3. once it is ready, create a PR to main branch for code review

Scripts

yarn build build all packages.

yarn lint run linter with eslint.

yarn stylecheck run style stylecheck with prettier.

yarn typecheck run typescript type check.

yarn test run unit tests with jest.

yarn testall run all linting, checks and tests.

yarn publish make a new release. Run this on main branch.