]> O.S.I.I.S - jp/vkvg.git/commitdiff
Document test behavior and reference image generation colinrlim/fix-cmake-and-improve-docs 162/head colinrlim/fix-cmake-and-improve-docs
authorColin Lim <44008906+colinrlim@users.noreply.github.com>
Tue, 21 Oct 2025 02:07:44 +0000 (22:07 -0400)
committerColin Lim <44008906+colinrlim@users.noreply.github.com>
Tue, 21 Oct 2025 02:07:44 +0000 (22:07 -0400)
Add Testing section to CONTRIBUTING.md explaining how to build
and run unit tests, and clarifying first-run behavior when
visual regression tests skip to generate reference images.

This addresses potential confusion for first-time contributors.

CONTRIBUTING.md

index 11cbc2e9464637e7adf377527904ae932cbd6c75..2c83d9bf851f8978e1e700e365fab8923f135c24 100644 (file)
@@ -29,6 +29,20 @@ In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susa
 6. Push changes to your fork
 7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
 
+### Testing
+
+To build and run unit tests:
+```bash
+cd vkvg
+mkdir build
+cd build
+cmake ..
+make
+./gunit_tests/unit_tests
+```
+
+**Note**: Visual regression tests will skip on first run to generate reference images in `ReferenceImages/`. Subsequent runs compare against these baselines.
+
 ## Getting Help
 
 Join us on [gitter](https://gitter.im/CSharpRapidOpenWidgets).