From b1b8acdde8e68288efe11b890b952c9d73ff12ec Mon Sep 17 00:00:00 2001 From: Chris B Date: Mon, 16 Oct 2023 17:23:53 -0500 Subject: [PATCH] [Docs] Update contributing doc for clang-format (#5873) Specify the clang-format requirement in the contributing documentation. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb463b313f..7ca785ee54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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** ```