= project-archetype

Project archetype for Teragrep projects.

The pom.xml examples are added to the main pom.xml file under <plugins>..</plugins> section.

== Mandatory plugins for java projects

=== checkstyle

Enforces certain coding standards, complements both enforcer and formatter plugins

=== enforcer

The enforcer plugin forces certain standards in pom.xml

=== formatter (spotless)

Will enforce and can automatically apply proper formatting and licensing information to project files.

Also known as spotless

=== rat

The rat plugin is used to enforce existence of correct licenses, will complement formatter plugin

== Other java project plugins

=== jacoco

Provides test coverity reports.

== Other files

=== workflows

Contains fully reusable templates or otherwise useful boilerplate for GitHub workflows

=== example-java-project

Contains example java project that uses mandatory plugins as described above