CONTRIBUTING.md

Contributing guidelines

As a contributor, here are the guidelines we would like you to follow:

• Contributing guidelines
  • Code of conduct
  • Reporting Bugs
  • Feature Requests
  • Development
    • Building
    • Testing
  • PR Submission
    • Tests
    • Docs + Examples

Code of conduct

Be sure to follow our code of conduct.

Reporting Bugs

• Before you open an issue report, see if anyone has already reported;
• Complete our bug template issue by providing details of what happened;
• To facilitate debugging, reproduce the error using our boilerplate on CodeSandBox.

Feature Requests

Just create a feature issue and let discuss.

Development

Building

npm build
// or
yarn build

Testing

npm test
// or
yarn test

PR Submission

Pull requests need at least two approves from collaborators to be merged; when the PR author is a collaborator, that counts as one.

Docs and examples

All commits that change or add features to the API must be done in a pull request that also updates examples and docs.

Tests

All commits that fix bugs or add new features need tests.