Skip to content

Latest commit

 

History

History
132 lines (86 loc) · 6.04 KB

CONTRIBUTING.md

File metadata and controls

132 lines (86 loc) · 6.04 KB
Raw

Contributing guide

Want to contribute? Great! We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... But first, read this page (including the small print at the end).

Legal

All original contributions to Quarkus are licensed under the ASL - Apache License, version 2.0 or later, or, if another license is specified as governing the file or directory being modified, such other license.

All contributions are subject to the Developer Certificate of Origin (DCO). The DCO text is also included verbatim in the dco.txt file in the root directory of the repository.

Reporting an issue

This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.

If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and what you would expect to see. Don't forget to indicate your Quarkus, Java, Maven/Gradle and GraalVM version.

Before you contribute

To contribute, use GitHub Pull Requests, from your own fork.

Code reviews

All submissions, including submissions by project members, need to be reviewed before being merged.

Continuous Integration

Because we are all humans, the project uses a continuous integration approach and each pull request triggers a full build. Please make sure to monitor the output of the build and act accordingly.

Tests and documentation are not optional

Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).

Be sure to test your pull request in:

  1. Java mode
  2. Native mode

Setup

If you have not done so on this machine, you need to:

  • Install Git and configure your GitHub access
  • Install Java SDK (OpenJDK recommended)
  • Install GraalVM (community edition is enough)
  • Install platform C developer tools:
    • Linux
      • Make sure headers are available on your system (you'll hit 'Basic header file missing (<zlib.h>)' error if they aren't).
        • On Fedora sudo dnf install zlib-devel
        • Otherwise sudo apt-get install libz-dev
    • macOS
      • xcode-select --install
  • Set GRAALVM_HOME to your GraalVM Home directory e.g. /opt/graalvm on Linux or $location/JDK/GraalVM/Contents/Home on macOS

Docker is not strictly necessary: it is used to run the MariaDB and PostgreSQL tests which are not enabled by default. However it is a recommended install if you plan to work on Quarkus JPA support:

IDE Config and Code Style

Quarkus has a strictly enforced code style. Code formatting is done by the Eclipse code formatter, using the config files found in the ide-config directory. By default when you run ./mvnw install the code will be formatted automatically. When submitting a pull request the CI build will fail if running the formatter results in any code changes, so it is recommended that you always run a full Maven build before submitting a pull request.

If you want to run the formatting without doing a full build, you can run ./mvnw process-sources.

Eclipse Setup

Open the Preferences window, and then navigate to Java -> Code Style -> Formatter. Click Import and then select the eclipse-format.xml file in the ide-config directory.

Next navigate to Java -> Code Style -> Organize Imports. Click Import and select the eclipse.importorder file.

IDEA Setup

Open the Preferences window, navigate to Plugins and install the Eclipse Code Formatter Plugin.

Restart your IDE, open the Preferences window again and navigate to Other Settings -> Eclipse Code Formatter.

Select Use the Eclipse Code Formatter, then change the Eclipse Java Formatter Config File to point to the eclipse-format.xml file in the ide-config directory. Make sure the Optimize Imports box is ticked, and select the eclipse.importorder file as the import order config file.

Build

  • Clone the repository: git clone https://github.com/quarkusio/quarkus.git
  • Navigate to the directory: cd quarkus
  • Invoke ./mvnw clean install from the root directory
git clone https://github.com/quarkusio/quarkus.git
cd quarkus
./mvnw clean install
# Wait... success!

The default build does not create native images, which is quite time consuming.

You can build and test native images in the integration tests supporting it by using ./mvnw install -Dnative.

By default the build will use the native image server. This speeds up the build, but can cause problems due to the cache not being invalidated correctly in some cases. To run a build with a new instance of the server you can use ./mvnw install -Dnative-image.new-server=true.

The small print

This project is an open source project, please act responsibly, be nice, polite and enjoy!

Frequently Asked Questions

  • IntelliJ fails to import Quarkus Maven project with java.lang.OutOfMemoryError: GC overhead limit exceeded

In IntelliJ IDEA (version older than 2019.2) if you see problems in the Maven view claiming java.lang.OutOfMemoryError: GC overhead limit exceeded that means the project import failed.

To fix the issue, you need to update the Maven importing settings:
Build, Execution, Deployment > Build Tools> Maven > Importing > VM options for importer To import Quarkus you need to define the JVM Max Heap Size (E.g. -Xmx1g)

Note: As for now, we can't provide a unique Max Heap Size value. We have been reported to require from 768M to more than 3G to import Quarkus properly.