Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.42 KB
Raw

Contributing guide

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/.

Setup

If you have not done so, you need to:

  1. install Git and configure your GitHub access
  2. install a JDK (for example Eclipse Temurin),
  3. install Gradle,
  4. install Quarkus CLI.

Please refer to .tool-versions for the exact versions. If you are using asdf, then you can install the required dependencies (except git) using the following commands :

asdf plugin-add java
asdf plugin-add gradle
asdf plugin-add quarkus
asdf install

Running the application in dev mode

You can run the application in dev mode that enables live coding using:

quarkus dev

Packaging and running the application

The application can be packaged using:

quarkus build

The application is now runnable using java -jar build/quarkus-app/quarkus-run.jar.

For more information have a look at Building Quarkus apps with Gradle.

Formatting the code

This project automatically format source code during build to comply with Google Java Style and make use of google-java-format for that. You can manually trigger code formatting using:

gradle spotlessApply

You are strongly encouraged to install a plugin in your IDE if one is available. Take a look at the google-java-format README to check.

Publish

Just create a new release with its corresponding tag from the GitHub release page, and the publish workflow will be triggered. The release name and its tag must be set to the version number : x.y.z. All information from the changelog must be copied in the release description.

After the workflow run, the new release will be available in the project Maven repository. Do not forget to also empty the changelog for the next release and to add a link the release notes in the artifact description.