From b4b54989c85b7f7eb1094a0bc58008bfb1453b0b Mon Sep 17 00:00:00 2001 From: Alexander McCord <11488393+alexmccord@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:28:04 -0700 Subject: [PATCH] Mention clang-format version requirements. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26579740..2940fa8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ As such, feature requests may not be accepted even if a comprehensive RFC is wri ## Code style Contributions to this project are expected to follow the existing code style. -`.clang-format` file mostly defines syntactic styling rules (you can run `make format` to format the code accordingly). +`.clang-format` file mostly defines syntactic styling rules (you can run `make format` to format the code accordingly). To avoid formatting inconsistencies, get a clang-format binary version >=15. As for naming conventions, most Luau components use `lowerCamelCase` for variables and functions, `UpperCamelCase` for types and enums, `kCamelCase` for global constants and `SCARY_CASE` for macros.