Skip to content

Commit

Permalink
[Docs] Update contributing doc for clang-format (microsoft#5873)
Browse files Browse the repository at this point in the history
Specify the clang-format requirement in the contributing documentation.
  • Loading branch information
llvm-beanz authored Oct 16, 2023
1 parent 7a4cdea commit b1b8acd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ Here's a few things you should always do when making changes to the code base:

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.

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.

**Commit/Pull Request Format**

```
Expand Down

0 comments on commit b1b8acd

Please sign in to comment.