diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4b04f2..eb18786 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,22 @@ This document outlines the conventions to follow when contributing to this proje ## Commit Policy -### Run Tests Before Committing +### Verify Build and Tests Before Committing -Before preparing or proposing a commit, you **must** run the entire local test suite and ensure that all tests pass. This is a critical step to prevent regressions and maintain the stability of the codebase. +Before preparing or proposing a commit, you **must** perform the following verifications to prevent regressions: -Refer to the "Testing" section in `HOWTO.md` for instructions on how to build and run the tests. +1. **MacOS / Linux (Native)**: + * Build the project (debug or release). + * Run the entire test suite (`ctest`). + * Ensure all tests pass. + +2. **Windows (Cross-Compilation)**: + * If `mingw-w64` is installed on your system, you **must** also verify the Windows build. + * Run `./scripts/build_win.sh`. + * Ensure the build succeeds and produces the `demo64k_packed.exe` binary. + * Check the size report to ensure no unexpected bloat. + +Refer to the "Testing" and "Windows Cross-Compilation" sections in `HOWTO.md` for detailed instructions. ### Format Code Before Committing |