Skip to content

Commit b1b8acd

Browse files
authored
[Docs] Update contributing doc for clang-format (microsoft#5873)
Specify the clang-format requirement in the contributing documentation.
1 parent 7a4cdea commit b1b8acd

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Here's a few things you should always do when making changes to the code base:
4444

4545
The coding, style, and general engineering guidelines follow those described in the docs/CodingStandards.rst. For additional guidelines in code specific to HLSL, see the docs/HLSLChanges.rst file.
4646

47+
DXC has adopted a clang-format requirement for all incoming changes. PRs to DXC should have the _changed code_ clang formatted to the LLVM style, and leave the remaining portions of the file unchanged. This can be done using the `git-clang-format` tool or IDE driven workflows. A GitHub action will run on all PRs to validate that the change is properly formatted.
48+
4749
**Commit/Pull Request Format**
4850

4951
```

0 commit comments

Comments
 (0)