diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1993cc8..1876960 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,17 @@ GitHub provides additional document on [forking a repository](https://help.githu #### Unit Tests +Before running the tests, ensure you have JAVA_HOME set to a compatible JDK installation (JDK 11 or later is required). For example: + +```bash +# macOS example +export JAVA_HOME=~/Library/Java/JavaVirtualMachines/temurin-11.jdk/Contents/Home +# Linux example +export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 +``` + +Note: When using JDK 17 or later, setting JAVA_HOME is especially important to avoid Mockito mocking errors during testing. + To verify unit tests pass run: ```bash