Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.45 KB

How to Contribute

We welcome contributions from the community. Here are a few ways you can help us improve.

Submit a Pull Request

If you find something you'd like to fix that's obviously broken, create a branch, commit your code, and submit a pull request. Here's how:

  1. Fork the repo on GitHub, and then clone it locally.
  2. Create a branch named appropriately for the change you are going to make.
  3. Make your code change.
  4. If you are creating a function, please add a tests for it if possible.
  5. Push your code change up to your forked repo.
  6. Open a Pull Request to merge your changes to this repo. The comment box will be filled in automatically via a template.
  7. All Pull Requests will be subject to Linting checks. Please make sure that your code complies and fix any warnings that arise. These are Checks that appear at the bottom of your Pull Request.
  8. All Pull requests are subject to Testing.

See Using Pull Requests got more information on how to use GitHub PRs.

For an in depth guide on how to contribute see this article

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.