This repository use
git flow(except for release branches, automated via CI). The default branch isdevelopand pull requests should be opened for him.
To contribute for this project:
- Use
aw-preffix in all new components; - Write unit tests;
- Doc props and args using TSDoc syntax (read about Stencil for more);
- Develop and test Storybook (run
npm run storybookoryarn storybook).
If you need help, be free for open a information issue or contact me.
Fork this repository and make changes. At end open a pull request for here with develop branch as target.
Pull request message should contains the following syntax for auto-changelog works:
# The number (#ID) is pull request ID auto generated by GitHub
# features, improvements, enhancements...
feature: Commit message (#ID)
# General fixes
fix: Commit message (#ID)
# API changes, breaking changes
break: Commit message (#ID)Any questions, start a discussion.
- Clone this repo
- Access the directory and run:
npm install
npm startTo build the component on production mode, run:
npm run buildTo run the unit tests for the components, run:
npm test
# or
npm run test:watchWhen creating new component tags, use the aw- preffix.