Document how to work with ClangFormat (#10468)

paramat · web-flow · commit fc2e120b03e6 · 2020-10-13T23:57:46.000+01:00
To avoid the common misunderstanding where a contributor thinks they
must apply the unsuitable formatting requests ClangFormat makes.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -43,6 +43,14 @@ Contributions are welcome! Here's how you can help:
 4. The code's interfaces are well designed, regardless of other aspects that might need more work in the future.
 5. It uses protocols and formats which include the required compatibility.
 
+### Important note about automated GitHub checks
+
+When you submit a pull request, GitHub automatically runs checks on the Minetest Engine combined with your changes. One of these checks is called 'cpp lint / clang format', which checks code formatting.
+Because formatting for readability requires human judgement this check often fails and often makes unsuitable formatting requests which make code readability worse.
+
+If this check fails, look at the details to check for any clear mistakes and correct those. However you should not apply everything ClangFormat requests, ignore requests that make code readability worse and any other clearly unsuitable requests.
+Discuss with a core developer if in any doubt and for how to progress.
+
 ## Issues
 
 If you experience an issue, we would like to know the details - especially when a stable release is on the way.
