Skip to content

Commit bc6a8af

Browse files
committed
Document transitioning to enforced formatting checks
1 parent f671dda commit bc6a8af

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

BUILDING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -638,5 +638,17 @@ directory of your KTX-Software workarea or set the value of the
638638
`KTX_SPECIFICATION` CMake cache variable to the location of your specification
639639
clone.
640640
641+
Formatting
642+
------------
643+
644+
The KTX repository is transitioning to enforcing a set of formatting guides, checked during CI.
645+
The tool used for this is [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html).
646+
To minimize friction, it is advised that one configure their environment to run ClangFormat in an automated fashion,
647+
minimally before committing to source control, ideally on every save.
648+
649+
### Visual Studio Code
650+
651+
Set the [`editor.formatOnSave`](https://code.visualstudio.com/docs/editor/codebasics#_formatting) option and use one of the C/C++ formatting extensions available, most notably [ms-vscode.cpptools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) or [llvm-vs-code-extensions.vscode-clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd).
652+
641653
642654
{# vim: set ai ts=4 sts=4 sw=2 expandtab textwidth=75:}

0 commit comments

Comments
 (0)