Skip to content

Commit 71f7270

Browse files
committed
Document that the code should be formatted according to a specific clang-format version
1 parent 21ba196 commit 71f7270

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ Please document your code in Doxygen compatible syntax.
6262
Please format your changes using [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html).
6363
A style configuration file is given: [`.clang-format`](.clang-format)
6464

65+
Unfortunately the output also depends on the clang-format version.
66+
The reference version to be used is the one used by the verification scripts ("CI/CD pipeline").
67+
6568
Although the standalone tool `clang-format` may be used, we recommend to integrate the formatting using a [plugin](https://firefox-source-docs.mozilla.org/code-quality/coding-style/format_cpp_code_with_clang-format.html#editor-plugins) for the editor of your choice.
6669

6770
#### Naming convention

0 commit comments

Comments
 (0)