demo/validator
1
0
Fork 0
mirror of https://github.com/itplr-kosit/validator.git synced 2026-05-25 16:55:39 +00:00
Code Issues Projects Releases Packages Wiki Activity
validator/docs/contribute.md
Andreas Penski (init) 06a88848db prepare docs for release 1.3.0
2020-05-15 10:01:32 +02:00

1.3 KiB
Raw Blame History

Setup development environment

Prerequisites

We use IntelliJ >= 2018.3 and OpenJDK 11 for development. If you like to contribute please use the following plugins:

  1. Checkstyle Plugin
  2. Lombok Plugin
  3. Eclipse Formatter Plugin (see below)

Any other IDE should be sufficient too. Just use suitable tools, plugins and setup comparable to our IntelliJ stuff.

Import into IDE

For IntelliJ we provide a suitable configuration within the code. Just clone the repository locally and open it in IntelliJ and you are up and running.

For other IDEs the correct setup is up to you.

Code Formatting

We use an automatic formatting of the source code in our environment. This is based on the Eclipse code formatter functionality due to historical reasons. This not only works in Eclipse but also in IntelliJ (via plugin) and can be used standalone.

The configuration can be found in .settings-directory. For IntelliJ this is all set up. Additionally this should work in Eclipse out of the box. Another potential usage scenario would be to integrate the formatter via git hooks into the commit-pipeline (e.g Example Hook ). For other IDEs you are on your own.

Build

Requirements

  • Maven > 3.0.0
  • Java > 8 update 111

Procedure

mvn install generates two different packages in the dist directory: