From e736fedb677a88daecb3b5c51c1469da2f56a6b7 Mon Sep 17 00:00:00 2001 From: Vlad Mihalcea Date: Mon, 27 Jun 2022 10:30:44 +0300 Subject: [PATCH] Update Readme to include information regarding building the project #447 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e67247806..6253135f9 100644 --- a/README.md +++ b/README.md @@ -264,3 +264,14 @@ Or, if you prefer reading books, you are going to love my [High-Performance Java High-Performance Java Persistence video course +#### Contributing Guide + +The project uses [Maven Toolchains](https://maven.apache.org/guides/mini/guide-using-toolchains.html) as different modules are compiled and tested using different Java versions. Hibernate Types 6 requires Java 17 while Hibernate Types 4 compiles with Java 1.6. + +To see how to configure Maven Toolchains, check out [this article](https://vladmihalcea.com/maven-and-java-multi-version-modules/). + +The project uses various database systems for integration testing, and you can configure the JDBC connection settings using the +`DatasourceProvider` instances (e.g., `PostgreSQLDataSourceProvider`). + +If you want to fix an issue or add support for a new feature, please provide the associated integration test case that proves the improvement is working as expected. +