summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-01-28 01:31:09 +0100
committerskal <pascal.massimino@gmail.com>2026-01-28 01:31:09 +0100
commitbc7411f855b1580e4cfbd067106222e98e59d49f (patch)
treef53b878a8c1214453744a48dcb3121580761f205
parent7ed0286e8cd40367ab6ba7f100e3b30d9d1ae383 (diff)
docs(contributing): Add clang-format directive
Adds a new directive to CONTRIBUTING.md requiring all code to be formatted with clang-format before committing, ensuring consistent style across the codebase.
-rw-r--r--CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 398a08f..45630d5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,3 +9,14 @@ This document outlines the conventions to follow when contributing to this proje
Before preparing or proposing a commit, you **must** run the entire local test suite and ensure that all tests pass. This is a critical step to prevent regressions and maintain the stability of the codebase.
Refer to the "Testing" section in `HOWTO.md` for instructions on how to build and run the tests.
+
+### Format Code Before Committing
+
+All code **must** be formatted using `clang-format` before committing. This ensures a consistent coding style across the entire codebase.
+
+To format your code, run the following command from the project root:
+```bash
+clang-format -i $(git ls-files | grep -E '\.(h|cc)$')
+```
+
+Refer to the `.clang-format` file in the project root for the specific style rules.