Skip to content
Permalink
Browse files

Contributing doc: Minor improvements and a clarification (#10520)

  • Loading branch information
paramat committed Oct 18, 2020
1 parent 738f624 commit db9eee2d80cc2a35bd133473d131f321dc4600c3
Showing with 2 additions and 4 deletions.
  1. +2 −4 .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

0 comments on commit db9eee2

Please sign in to comment.
You can’t perform that action at this time.