Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (31 loc) · 776 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (31 loc) · 776 Bytes
Raw

Contributing Guidelines

  • When submitting a PR,
    • If it is a fix, add a test to catch the bug.
    • If it is a feature, of course still add a test and don't forget to update the documentation.
    • If it is a documentation update, please make sure to double check your grammar.
    • If it is a breaking change, at the very least, create a ticket for updating affected projects.
  • Do not forget to update the package version.

Setup

npm install

Build

npm run build

Test

npm test will always build the library before running tests.

npm test

Publishing

git tag -a <version> -m 'brief description for the new version changes'
npm login
npm publish

Documentation

npm run docs
open docs/index.html