Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 5 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 5 KB

How to contribute to the OpenVINO repository

We welcome community contributions to OpenVINO™. Please read the following guide to learn how to find ideas for contribution, practices for good pull requests, checking your changes with our tests and more.

Before you start contributing you should

  • Make sure you agree to contribute your code under OpenVINO™ (Apache 2.0) license.
  • Figure out what you’re going to contribute. If you don’t know what you are going to work on, navigate to the Github "Issues" tab. Make sure that there isn't someone working on it. In the latter case you might provide support or suggestion in the issue or in the linked pull request.
  • If you are going to fix a bug, check that it's still exists in the latest release. This can be done by building the latest master branch, and make sure that the error is still reproducible there. We do not fix bugs that only affect older non-LTS releases like 2020.2 for example (more details about branching strategy).

"Fork & Pull Request model" for code contribution

The instruction in brief

Making a good pull request

Following these guidelines will increase the likelihood of your pull request being accepted:

  • One PR – one issue.
  • Build perfectly on your local system.
  • Choose the right base branch Branches.
  • Follow the Coding Style Guide for your code.
  • Update documentation using Documentation guidelines if needed.
  • Cover your changes with test.
  • Add license at the top of new files C++ example, Python example.
  • Add enough information: a meaningful title, the reason why you made the commit and a link to the issue page if exists.
  • Remove unrelated to PR changes.
  • If it is still WIP and you want to check CI test results early then use Draft PR.
  • Submit your PR and become an OpenVINO™ contributor!

Testing and merging pull requests

Your pull request will be automatically tested by OpenVINO™'s precommit (testing status are automatically reported as "green" or "red" circles in precommit steps on PR's page). If any builders have failed, you need fix the issue. To rerun the automatic builds just push changes to your branch on GitHub. No need to close pull request and open a new one!

Merging PR

When the reviewer accepts the pull request and the pre-commit shows a "green" status, the review status is set to "Approved", which signals to the OpenVINO™ maintainers that they can merge your pull request.