aboutsummaryrefslogtreecommitdiffstats
path: root/README-maintainer
diff options
context:
space:
mode:
Diffstat (limited to 'README-maintainer')
-rw-r--r--README-maintainer9
1 files changed, 9 insertions, 0 deletions
diff --git a/README-maintainer b/README-maintainer
index 49dc643f..b43f183b 100644
--- a/README-maintainer
+++ b/README-maintainer
@@ -86,6 +86,15 @@ GOOGLE OSS-FUZZ
CODING RULES
+* In a source file, include the header file that declares the source
+ class first followed by a blank line. If a config file is needed
+ first, put a blank line between that and the header followed by
+ another blank line. This assures that each header file is included
+ first at least once, thereby ensuring that it explicitly includes
+ all the headers it needs, which in turn alleviates lots of header
+ ordering problems. The blank line ensures that formatters don't
+ messt his up by resorting the headers.
+
* Avoid atoi. Use QUtil::string_to_int instead. It does
overflow/underflow checking.