diff options
| author | practicalswift <practicalswift@users.noreply.github.com> | 2018-05-23 14:56:49 +0200 |
|---|---|---|
| committer | practicalswift <practicalswift@users.noreply.github.com> | 2018-05-23 15:52:55 +0200 |
| commit | 419a1983ca6bdb32cf0ecd297f7ffccf518d2424 (patch) | |
| tree | f180f6ed9b280c764a058564c03f5c039667e683 /doc | |
| parent | 6916024768ec57a00f54224640ab4e4871d2a30a (diff) | |
docs: Add a note about the source code filename naming convention
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 1f237b750e..960c6a0244 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. |