Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 1.46 KB
Raw

Contribution guide

This repository use git flow (except for release branches, automated via CI). The default branch is develop and pull requests should be opened for him.

To contribute for this project:

  1. Use aw- preffix in all new components;
  2. Write unit tests;
  3. Doc props and args using TSDoc syntax (read about Stencil for more);
  4. Develop and test Storybook (run npm run storybook or yarn storybook).

If you need help, be free for open a information issue or contact me.

Start

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.

Developing

  • Clone this repo
  • Access the directory and run:
npm install
npm start

To build the component on production mode, run:

npm run build

To run the unit tests for the components, run:

npm test

# or 

npm run test:watch

Naming Components

When creating new component tags, use the aw- preffix.