Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 1.47 KB
Raw

Contributing

PRs Welcome

Thank you for opening (and reading) this document. :) We are open to, and grateful for, any contributions made.

Semantic Versioning

This repository generally follows semantic versioning. We release patch versions for bug fixes, minor versions for new features, and major versions for any breaking changes.

All releases to npm or any other supported distribution channels will corresponding to a tagged commit.

Testing

To only run linting:

npm run lint

To only run tests:

npm run test

To get coverage report:

npm run test && npm run coverage

To continuously watch and run tests, run the following:

npm run test:watch

Sending a Pull Request

If you send a pull request, please do it against the master branch. Please do no bump the version and tag your pull request with a v[number] as it corresponds to a release.

Before submitting a pull request, please make sure the following is done:

  • Fork the repository and create your branch from master.
  • If you've added code that should be tested, add tests!
  • Ensure the test suite passes (npm run test).
  • Make sure your code lints (npm run lint).
  • Make sure coverage is decent (run npm run coverage after running npm run test)

Thank you for contributing!