From 7b62e3ad2d23dba45f176d9c4feaf7ee2614e98f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Lam?= Date: Fri, 31 Dec 2021 19:36:33 +0100 Subject: [PATCH] contributing: Explain the clang-format requirement --- Contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Contributing.md b/Contributing.md index 92a05a82..ed8e4560 100644 --- a/Contributing.md +++ b/Contributing.md @@ -109,9 +109,9 @@ CLion interacts with CMake directly, so you need to make sure CLion's build prof ## Code style -This project uses clang-format to enforce a consistent coding style. Before opening a PR, please format your code with clang-format 12 and ensure the following guidelines are followed. +BotW has 40MB of code and contributors *need* to read and modify existing parts of the codebase very often: inconsistencies lead to a loss of efficiency, and we literally cannot afford that considering our small number of contributors. To avoid wasting time on formatting issues, we use clang-format to automatically enforce a consistent coding style. -This will allow your contributions to be reviewed more quickly. +Before opening a PR, please format your code with clang-format 12 and ensure the following guidelines are followed. This will allow your contributions to be reviewed more quickly. ### General