Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.27 KB
Raw

Contributing

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use GitHub Flow

Pull requests are the best way to propose changes to the codebase (we use GitHub Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue a pull request.

Use a Consistent Coding Style

  • Lint your code to avoid errors:
$ yarn lint
  • Format your code to improve readability:
$ yarn format

Useful Resources

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.