Development

Build Instructions

ModelPolisher uses gradle to build. Make sure you have gradle (version >= 5.0) installed in your system before following the procedure below.

Gradle

First clone this repository and go to directory <path>/ModelPolisher/. Then, ModelPolisher can be built using Gradle. Your safest bet is to run gradle fatJar, which bundles all necessary dependencies in the build artifact. Running gradle build will leave you responsible for satisfying classpath requirements of the project.

Build artifacts will be placed in <path>/ModelPolisher/target/

Additionally gradle devel is provided to easily run a non-release version with Docker.

Setting up necessary databases

NOTE: lightJar requires postgresql database(s) to be set-up to run ModelPolisher.

Best Practices

• Please include the prefix issue #<issue-number> in every commit message. If there is no issue that your commit belongs to, create one. Doing this will link the commit to the message in GitHub (and most git client applications). This is essential to comprehend the development history and the current state of development on any open issues.