File tree Expand file tree Collapse file tree 1 file changed +23
-0
lines changed Expand file tree Collapse file tree 1 file changed +23
-0
lines changed Original file line number Diff line number Diff line change @@ -657,6 +657,29 @@ directory. The path to this directory is available in a lit test with the varia
657
657
.. _FileCheck : https://llvm.org/docs/CommandGuide/FileCheck.html
658
658
.. _test/clang-tidy/checkers/google/readability-casting.cpp : https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/test/clang-tidy/checkers/google/readability-casting.cpp
659
659
660
+
661
+ Submitting a Pull Request
662
+ -------------------------
663
+
664
+ Before submitting a pull request, contributors are encouraged to run
665
+ :program: `clang-tidy ` and :program: `clang-format ` on their changes to ensure
666
+ code quality and catch potential issues. While :program: `clang-tidy ` is not
667
+ currently enforced in CI, following this practice helps maintain code
668
+ consistency and prevent common errors.
669
+
670
+ Here's useful command to check your staged changes:
671
+
672
+ .. code-block :: console
673
+
674
+ $ git diff --staged -U0 | ./clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py \
675
+ -j $(nproc) -path build/ -p1 -only-check-in-db
676
+ $ git clang-format
677
+
678
+ Note that some warnings may be false positives or require careful consideration
679
+ before fixing. Use your judgment and feel free to discuss in the pull request
680
+ if you're unsure about a particular warning.
681
+
682
+
660
683
Out-of-tree check plugins
661
684
-------------------------
662
685
You can’t perform that action at this time.
0 commit comments