diff options
| author | skal <pascal.massimino@gmail.com> | 2026-01-28 09:31:13 +0100 |
|---|---|---|
| committer | skal <pascal.massimino@gmail.com> | 2026-01-28 09:31:13 +0100 |
| commit | 302d883f34864bc66a5e04532ae27d7e89fd94e8 (patch) | |
| tree | 8f813865d5dc5b70ee8bf9ee4866546116859825 /CONTRIBUTING.md | |
| parent | f804dcb9740540b3735628ebf8c006235cc56fca (diff) | |
style: Add 3-line descriptive headers to all source files
This commit applies a new project-wide rule that every source file must begin with a concise 3-line comment header describing its purpose.
- Updated CONTRIBUTING.md with the new rule.
- Applied headers to all .cc and .h files in src/ and tools/.
- Fixed various minor compilation errors and missing includes discovered during the header update process.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffacc81..e0a4cf7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,3 +20,14 @@ clang-format -i $(git ls-files | grep -E '\.(h|cc)$' | grep -vE '^(assets|archiv ``` Refer to the `.clang-format` file in the project root for the specific style rules. + +### Source File Headers + +Every source file (`.h`, `.cc`) must begin with a concise 3-line comment header describing its purpose. + +Example: +```cpp +// This file is part of the 64k demo project. +// It implements the core audio synthesis engine. +// Contact: demo-team@example.com +``` |
