CONTRIBUTING.md

Contributing

We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request and anything that you build and share using our components.

Communication channels

• Communication is primarily done using issues.
• If you need support as soon as possible and you can't wait for any pull request, feel free to use our support.
• As a last resort measure or on otherwise important matter you may also contact us directly.

Ways to help

• Report bugs
  Create an issue or send a pull request
• Send pull requests
  If you want to contribute code, check out the development instructions below.
  • However when contributing larger new features, please first discuss the change you wish to make via issue with the owners of this repository before making it.
    Otherwise your work might be rejected and your effort was pointless.

We also encourage you to read the contribution instructions by GitHub.

Developing

Software Requirements

You should have the following things installed:

• Git
• Java 21 - should be as unmodified as possible (Recommended: Eclipse Adoptium)
• Maven (Note that the Maven Wrapper is shipped with the repo)

Recommended setup

• Install IntelliJ (Community Edition is sufficient)
  • Install the following plugins:
    • Save Actions - Provides save actions, like running the formatter or adding final to fields
    • SonarLint - CodeStyle/CodeAnalysis
      • You may consider disabling telemetry in the settings under Tools > Sonarlint -> About
    • Checkstyle-IDEA - CodeStyle/CodeAnalysis
  • Import the project
  • Ensure that everything is encoded in UTF-8
  • Ensure that the JDK/Java-Version is correct

Releasing

Before releasing:

• Consider doing a test-deployment before actually releasing.
• Check the changelog

If the develop is ready for release, create a pull request to the master-Branch and merge the changes

When the release is finished do the following:

• Merge the auto-generated PR (with the incremented version number) back into the develop