Fixes #1781 (#1782)

open-telemetry · Nov 17, 2022 · d0571d8 · d0571d8
1 parent 8da88df
commit d0571d8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -87,6 +87,12 @@ git submodule init
 git submodule update
 ```
 
+The source code is automatically formatted using clang-format.
+
+The output can vary between versions, so make sure to install `clang-format`
+version `10.0`, and have `clang-format-10` in your execution path,
+so that the helper script `tools/format.sh` can find it.
+
 Check out a new branch, make modifications and push the branch to your fork:
 
 ```sh

diff --git a/tools/format.sh b/tools/format.sh
@@ -22,7 +22,7 @@ fi
 # No trailing spaces.
 "${SED[@]}" 's/ \+$//' $($FIND -type f -print)
 
-# If not overridden, try to use clang-format-8 or clang-format.
+# If not overridden, try to use clang-format-10 or clang-format.
 if [[ -z "$CLANG_FORMAT" ]]; then
   CLANG_FORMAT=clang-format
   if which clang-format-10 >/dev/null; then