Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.48 KB
Raw

Contributing

Before contributing to this repository, please first discuss the change you wish to make by reporting an issue.

Please note we have a our Code of Conduct, please follow it in all your interactions with the project and the other contributors.

Reporting an issue

If you found a bug, other issue, or a potential improvement, please create an issue, so we would have a chance to discuss it, before you start working on it.

  1. Create an issue.
  2. Make sure you include:
    • For bugs: Steps to reproduce, minimal code example, expected behaviour, actual behaviour.
    • For feature request: Short description of the feature, potential use cases, possible impact on bundle size and performance.
  3. Please be patient until we have a chance to review the issue and get back to you.

Pull Request Process

  1. Checkout the latest master branch.
  2. Create a new branch, use the dev/ prefix for its name.
  3. Make your changes:
    • Single commit, with a proper, meaningful commit message.
    • Preferably no external dependencies.
    • The old tests should still pass.
    • Maintain a 100% test coverage. Cover new code with new tests.
    • Update the README.md if necessary.
    • Don't update the version in package.json.
  4. Create a pull request towards master.
    • Include the link to the related issue.
  5. Thank you! You are an awesome person. Please be patient, until we have a chance to review and (hopefully) merge your change and release it in a new version.