summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
3 daysrefactor(build): Centralize generated files and clean up project layoutskal
- Task A: Centralized all generated code (assets, timeline) into a single directory to create a single source of truth. - Task A: Isolated test asset generation into a temporary build directory, preventing pollution of the main source tree. - Task B: Vertically compacted all C/C++ source files by removing superfluous newlines. - Task C: Created a top-level README.md with project overview and file descriptions. - Task D: Moved non-essential documentation into a directory to reduce root-level clutter.
5 daysupdate coding rulesskal
5 daysdocs: Capture Sequence system and debugging protocolsskal
Updates HOWTO.md with instructions for the --seek flag and assets/demo.seq editing. Updates CONTRIBUTING.md with the protocol for adding and registering new visual effects.
5 daysdocs: Update contributing guidelines to mandate Windows build verificationskal
Expands the pre-commit policy to require verifying the Windows build (stripped and packed) if mingw-w64 is present, in addition to the standard native build and tests.
6 daysmore style rulesskal
6 daysadd mini_math.h header-only vector libskal
8 daysdocs(contributing): Add rule for newline at end of fileskal
Enforces a newline at the end of all source files to prevent linting errors and ensure consistent file formatting.
8 daysstyle: Add 3-line descriptive headers to all source filesskal
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.
9 daysdocs(contributing): Exclude third_party/ from clang-formatskal
Updates the clang-format command in CONTRIBUTING.md to explicitly exclude the 'third_party/' directory. This prevents clang-format from modifying external library code and avoids potential processing issues.
9 daysdocs(contributing): Exclude assets/ and archive/ from clang-formatskal
Updates the clang-format command in CONTRIBUTING.md to explicitly exclude the 'assets/' and 'archive/' directories. This prevents clang-format from attempting to process large, non-source files in these directories, which can cause hangs or unexpected behavior.
9 daysdocs(contributing): Add clang-format directiveskal
Adds a new directive to CONTRIBUTING.md requiring all code to be formatted with clang-format before committing, ensuring consistent style across the codebase.
9 daysfeat: Implement spectool & specview; refactor coding style; update docsskal
This commit introduces new tools for spectrogram manipulation and visualization, establishes a consistent coding style, and updates project documentation. Key changes include: - **Spectrogram Tools: - : A command-line utility for analyzing WAV/MP3 files into custom spectrogram format and playing back these spectrograms via the synth engine. - : A command-line tool for visualizing spectrogram files as ASCII art in the console. - **Coding Style Enforcement: - Added a configuration file enforcing LLVM-based style with 2-space indentation, no tabs, and an 80-column line limit. - Renamed all C++ source files from to for project consistency. - Applied automatic formatting using exit across the entire codebase. - **Documentation & Workflow: - Created to define a commit policy requiring tests to pass before committing. - Updated with instructions for building and using and , and referenced . - Updated and to reflect the new tools, audio architecture decisions (real-time additive synthesis, double-buffering for dynamic updates, WAV/MP3 support), coding style, and development workflow. - **Build System: - Modified to: - Include new targets for and under the option. - Update source file extensions to . - Add a new end-to-end test for to the suite.