From 419a1983ca6bdb32cf0ecd297f7ffccf518d2424 Mon Sep 17 00:00:00 2001 From: practicalswift Date: Wed, 23 May 2018 14:56:49 +0200 Subject: [PATCH] docs: Add a note about the source code filename naming convention --- doc/developer-notes.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 1f237b750..960c6a024 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -567,6 +567,12 @@ Source code organization - *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time +- Use only the lowercase alphanumerics (`a-z0-9`), underscore (`_`) and hyphen (`-`) in source code filenames. + + - *Rationale*: `grep`:ing and auto-completing filenames is easier when using a consistent + naming pattern. Potential problems when building on case-insensitive filesystems are + avoided when using only lowercase characters in source code filenames. + - Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other definitions from, even if those headers are already included indirectly through other headers.