Hi! We are really excited that you are interested in contributing to this repository. Before submitting your contribution, please make sure to take a moment and read through the following guide:
Starts the development server or runs a demo script (e.g. core
project).
$ npm run dev
Builds static files into the dist
folder.
$ npm run build
npm run test
A coverage summary is printed out to the console and an HTML report is generated in /coverage/lcov-report/index.html
.
npm run lint
- Fork the repo.
- Create a branch from
master
. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Run
npm run test
and ensure the test suite passes. - PRs must be rebased before merge.
- PR should be reviewed by at least one maintainer prior to merging.`
You don't need to worry about code style as long as you have installed the dev dependencies – modified files should automatically be formatted with Prettier when committing (via Git Hooks). For committing please run npm run commit
and you will get the prompts needed to start a commit.