Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (24 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.24 KB

Contributing to examples

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

If you're new, we encourage you to take a look at issues tagged with good first issue

For new examples

  1. Create a GitHub issue proposing a new example and make sure it's substantially different from an existing one.
  2. Fork the repo and create your branch from main.
  3. If you've added code that should be tested, add tests
  4. Verify that there are no issues in your build.
  5. Ensure your test passes locally.
  6. Address any feedback in code review promptly.

For bug fixes

  1. Fork the repo and create your branch from main.
  2. Make your code change.
  3. Write unit tests for your bug fixes
  4. Then, make sure that unit tests pass locally
  5. Address any feedback in code review promptly.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

License

By contributing to examples, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.