summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorParamat <paramat@users.noreply.github.com>2020-10-18 22:50:31 +0100
committerGitHub <noreply@github.com>2020-10-18 22:50:31 +0100
commitdb9eee2d80cc2a35bd133473d131f321dc4600c3 (patch)
tree6ace64d125b613a7a1a467bf8d9969aa81248573 /.github
parent738f62421872c0be5fcd483ad4573e5d879e7418 (diff)
downloadminetest-db9eee2d80cc2a35bd133473d131f321dc4600c3.tar.gz
minetest-db9eee2d80cc2a35bd133473d131f321dc4600c3.tar.bz2
minetest-db9eee2d80cc2a35bd133473d131f321dc4600c3.zip
Contributing doc: Minor improvements and a clarification (#10520)
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index e57ea9f83..b01a89509 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -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