diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9e1071bfa1..a5345f7bdd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ We welcome community contributions to OpenVINO™. Please read the following gui - Choose a base branch for your work. More details about branches and policies are here: [Branches](https://github.com/openvinotoolkit/openvino/wiki/Branches) - Clone your fork to your computer. - Create a new branch (with a meaningful name) from the base branch you chose. -- Modify / add the code following our [Coding Style Guide](https://github.com/openvinotoolkit/openvino/wiki/CodingStyleGuideLines). +- Modify / add the code following our [Coding Style Guide](./docs/dev/coding_style.md). - If you want to add a new sample, please look at this [Guide for contributing to C++/C/Python IE samples](https://github.com/openvinotoolkit/openvino/wiki/SampleContribute) - If you want to contribute to the documentation and want to add a new guide, follow that instruction [Documentation guidelines](https://github.com/openvinotoolkit/openvino/wiki/CodingStyleGuideLinesDocumentation) - Run testsuite locally: @@ -52,4 +52,4 @@ Your pull request will be automatically tested by OpenVINO™'s precommit (testi ## Merging PR -As soon as the reviewer is fine with the pull request and precommit shows "green" status, the "Approved" review status is put, which signals OpenVINO™ maintainers that they can merge your pull request. +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. diff --git a/README.md b/README.md index a609d0185b0..339eeeb68a9 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ The latest documentation for OpenVINO™ Toolkit is available [here](https://doc ### Developer documentation -[Developer documentation](./docs/dev/index.md) contains information about architectural decisions which are applied inside the OpenVINO components. This documentation has all necessary information which could be needed in order to contribute to OpenVINO. +[Developer documentation](./docs/dev/index.md) contains information about architectural decisions used inside the OpenVINO components. This documentation has all necessary information for contribution to OpenVINO. ## Tutorials diff --git a/docs/dev/coding_style.md b/docs/dev/coding_style.md index adcdd620455..62d45e61293 100644 --- a/docs/dev/coding_style.md +++ b/docs/dev/coding_style.md @@ -2,20 +2,20 @@ ## Coding style -Majority of OpenVINO components use `clang-format-9` for code style check. +The majority of OpenVINO components use `clang-format-9` for code style check. -The code style is based on Google Code style with some differences. All differences are described in the configuration file: +The code style is based on the Google Code style with some differences. All the differences are described in the configuration file: https://github.com/openvinotoolkit/openvino/blob/69f709028a5f8da596d1d0df9a0101e517c35708/src/.clang-format#L1-L28 -To fix code style on your local machine, you need to have installed `clang-format-9` tool and be sure that CMake option `ENABLE_CLANG_FORMAT` is enabled. -If all dependencies are resolved, `clang_format_fix_all` target can be used to fix all code style issues. +To fix the code style on your local machine, you need to install the `clang-format-9` tool and make sure that the CMake option `ENABLE_CLANG_FORMAT` is enabled. +If all dependencies are resolved, you can use the `clang_format_fix_all` target to fix all code style issues. ## Naming style -OpenVINO has a strict rules for naming style in public API. All classes should be started from capital letter, methods and functions are named in `snake_case` style. -To check the naming style `ncc` tool is integrated inside the OpenVINO. The detailed information about naming style can be found in the [configuration file](../../cmake/developer_package/ncc_naming_style/openvino.style). -In order to activate this tool you need to have `clang` on the local machine and enabled CMake option `ENABLE_NCC_STYLE`. -After that `ncc_all` target can be used to check the naming style. +OpenVINO has strict rules for naming style in public API. All classes must start with a capital letter, and methods and functions should be named in `snake_case` style. +To check the naming style, `ncc` tool is integrated in the OpenVINO. Read the detailed information about the naming style can be found in the [configuration file](../../cmake/developer_package/ncc_naming_style/openvino.style). +To activate this tool, you need to have `clang` on the local machine and enable the CMake option `ENABLE_NCC_STYLE`. +After that, you can use the `ncc_all` target to check the naming style. ## See also * [OpenVINO™ README](../../README.md)