Skip to content

Commit 419a198

Browse files
docs: Add a note about the source code filename naming convention
1 parent 6916024 commit 419a198

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/developer-notes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,12 @@ Source code organization
567567
568568
- *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time
569569
570+
- Use only the lowercase alphanumerics (`a-z0-9`), underscore (`_`) and hyphen (`-`) in source code filenames.
571+
572+
- *Rationale*: `grep`:ing and auto-completing filenames is easier when using a consistent
573+
naming pattern. Potential problems when building on case-insensitive filesystems are
574+
avoided when using only lowercase characters in source code filenames.
575+
570576
- Every `.cpp` and `.h` file should `#include` every header file it directly uses classes, functions or other
571577
definitions from, even if those headers are already included indirectly through other headers.
572578

0 commit comments

Comments
 (0)