Skip to content

Latest commit

 

History

History
executable file
·
40 lines (27 loc) · 1.3 KB

contributing.md

File metadata and controls

executable file
·
40 lines (27 loc) · 1.3 KB
Raw

Contributing

This doc needs help! Please submit your PR...

Commit messages

We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run yarn cm to use commitizen to properly format your commit messages so they can be automatically processed and included in release notes.

Pull request testing

Some notes on testing and releasing.

  • For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
  • To start a development server:
yarn build
cd example
yarn
yarn start
  • Provide feedback on the PR about your results.

Doing a release

We are using semantic-release instead of this:

  • update the version number in package.json
    • Fixes update the patch number, features update the minor number.
    • Major version update is reserved for API breaking changes, not just additions.
  • yarn github-changes -- -n 3.X.Y to update the changelog
  • git add, git commit and git push to get the version to master.
  • git tag -a 3.X.Y -m 3.X.Y git push --tags
  • npm publish
  • add a version on the github release page, based on the tag

Typescript Type Definitions

Ensure that any changes modifying the props or staticmethods are also reflected in the typescript type definitions file.