We welcome community contributions to the DockerHub CI framework for Intel® Distribution of OpenVINO™ toolkit repository.
Please read this document first. Thanks!
If you have an idea how to improve the product, please share it with us doing the following steps:
- Install the packages specified in requirements_dev.txt that are required for checking your code.
pip install -r requirements_dev.txt - Check code style (PEP8). Code style is strictly enforced by CI rules with flake8 tool
python -m flake8 ./ --config=setup.cfg --show-source - Make static type check. Static type analysis is strictly enforced by CI rules with mypy tool
python -m mypy ./ --config-file ./setup.cfg --show-error-context --show-column-numbers --pretty - Make sure you can build the docker image, run all tests with your patch
- In case of a larger feature, provide relevant unit tests
- Follow our SECURITY guide
- Submit a pull request at https://github.com/openvinotoolkit/docker_ci/pulls
We will review your contribution and, if any additional fixes or modifications are necessary, may give some feedback to guide you.
Your pull request will be merged into GitHub* repositories if accepted.
Notes:
If you fix a know submited issue, please mentioned its number in MR or directly in the footer of commit message (i.e. "Fixes #123")
We try to follow Conventional Commits specification, please do too.