From: Colin Lim <44008906+colinrlim@users.noreply.github.com>
Date: Tue, 21 Oct 2025 02:07:44 +0000 (-0400)
Subject: Document test behavior and reference image generation
X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=refs%2Fpull%2F162%2Fhead;p=jp%2Fvkvg.git

Document test behavior and reference image generation

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.
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 11cbc2e..2c83d9b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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).