From 302d883f34864bc66a5e04532ae27d7e89fd94e8 Mon Sep 17 00:00:00 2001
From: skal <pascal.massimino@gmail.com>
Date: Wed, 28 Jan 2026 09:31:13 +0100
Subject: 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.
---
 CONTRIBUTING.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'CONTRIBUTING.md')

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
+```
-- 
cgit v1.2.3