diff options
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 +``` |