forked from Illarion-eV/Illarion-Server
-
Notifications
You must be signed in to change notification settings - Fork 2
/
CONTRIBUTING
31 lines (26 loc) · 1.11 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
There may be legacy code violating the listed guidelines, new code however has to be compliant.
By order of precedence:
Illarion Coding Style: https://github.com/vilarion/Illarion-Coding-Style
C++ Core Guidelines: https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md
Some formatting rules are reflected by .clang-format, you can apply these as needed with clang-format.
Suitable editors allow you to automatically apply these rules on saving a file.
New code must not add more clang-tidy warnings under the following rules:
cppcoreguidelines-*
modernize-*
bugprone-*
performance-*
readability-*
clang-analyzer-api*
clang-analyzer-core*
clang-analyzer-cplusplus*
clang-analyzer-dead*
clang-analyzer-fuchsia*
clang-analyzer-nullability*
clang-analyzer-optin*
clang-analyzer-security*
clang-analyzer-unix*
New code must not add more cppcheck warnings, unless these are known false positives.
You do not need to install these tools yourself. Using Docker, you can easily run the correct versions:
* cppcheck: `tools/run-cppcheck`
* clang-tidy: `tools/run-clang-tidy`
* clang-format: `tools/run-clang-format`