You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-4Lines changed: 37 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -480,15 +480,48 @@ In some cases, you may need to perform a full clean that deletes all build artif
480
480
./build.sh clean-all
481
481
```
482
482
483
-
### Clang format
484
-
CPP SDK is using clang C++ format
483
+
## Quality Checks
484
+
485
+
This SDK leverages various tools and checks to ensure the highest quality of the code.
486
+
487
+
### Clang Tools
488
+
489
+
-`clang-tidy`: static analysis checks to catch common C++ pitfalls. See [.clang-tidy](./.clang-tidy) for the list of current checks (enforced in CI on PR)
490
+
-`clang-format`: (coming soon) code formatting and style consistency
491
+
492
+
> **Note**: clang-tidy is not currently supported on Windows for this project because the Visual Studio CMake generator does not produce the compile_commands.json database that clang-tidy requires.
493
+
494
+
To run locally, first install the following:
495
+
496
+
**macOS:**
497
+
485
498
```bash
486
-
brew install clang-format
499
+
# macOS
500
+
brew install llvm
487
501
```
488
502
503
+
This installs `clang-format`, `clang-tidy`, and `run-clang-tidy`. Homebrew may ask you to add `/opt/homebrew/opt/llvm/bin` to your `PATH`.
0 commit comments