]> git.lizzy.rs Git - dragonfireclient.git/commitdiff
Contributing doc: Minor improvements and a clarification (#10520)
authorParamat <paramat@users.noreply.github.com>
Sun, 18 Oct 2020 21:50:31 +0000 (22:50 +0100)
committerGitHub <noreply@github.com>
Sun, 18 Oct 2020 21:50:31 +0000 (22:50 +0100)
.github/CONTRIBUTING.md

index e57ea9f83c10c9a3fe9816f428c1be9b5017f016..b01a89509c8d5df7e83a04dfb22eed6c7dd2c386 100644 (file)
@@ -45,11 +45,9 @@ Contributions are welcome! Here's how you can help:
 
 ### 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.
+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.
+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 in the pull request with a core developer about how to progress.
 
 ## Issues