summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLiav A <liavalb@gmail.com>2022-12-04 16:32:33 +0200
committerAndrew Kaster <andrewdkaster@gmail.com>2022-12-04 09:13:24 -0700
commitbef9ad4e44eb81c16b02b2f3246c28fab8692746 (patch)
tree0989cdd24c0f1a8c4ff25ae6d2e67003f4e7af89 /CONTRIBUTING.md
parent88ecc4a1e58a7c8f5e2fb6e3d1d7c7b26332e50c (diff)
downloadserenity-bef9ad4e44eb81c16b02b2f3246c28fab8692746.zip
Meta: Update all references of clang-format-14 to clang-format-15
Also, we add a section that describes how to get an updated clang-format with multiple possible options to do that.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62d384ae93..47e3684a83 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -40,7 +40,7 @@ Nobody is perfect, and sometimes we mess things up. That said, here are some goo
**Do:**
* Write in idiomatic SerenityOS C++20, using the `AK` containers in all code.
-* Conform to the project coding style found in [CodingStyle.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md). Use `clang-format` (version 14 or later) to automatically format C++ files.
+* Conform to the project coding style found in [CodingStyle.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md). Use `clang-format` (version 15 or later) to automatically format C++ files. See [AdvancedBuildInstructions.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md) in Clang-format updates section to check how to acquire the tool.
* Choose expressive variable, function and class names. Make it as obvious as possible what the code is doing.
* Split your changes into separate, atomic commits (i.e. A commit per feature or fix, where the build, tests and the system are all functioning).
* Make sure your commits are rebased on the master branch.