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.
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 versions.
Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).
This extension supports RESTEasy Reactive and RESTEasy Classic. We have one profile for each implementation. By default, tests are run with RESTEasy Classic.
To run the tests using RESTEasy Reactive, use the resteasy-reactive profile, like the following:
mvn verify -Presteasy-reactiveTo run the tests using RESTEasy Classic, use the resteasy-classic profile, like the following:
mvn verify -Presteasy-classicMost of the tests are the same for both RESTEasy implementations, but a few of them require different code, like the multipart-request integration test. For these cases, we have one test for each implementation, using the org.junit.jupiter.api.Tag annotation to specify the profile for each of them.
Maven automatically formats code and organizes imports when you run mvn verify. So, we recommend you do that before sending your PR. Otherwise, PR checks will fail.
We no longer offer support for Quarkus 2. This extension used to support versions 3 and 2 of Quarkus and the code base was different for each Quarkus version. Therefore, we have the main branch supporting Quarkus 3, and the quarkus2 archived branch supporting Quarkus 2. Note that no updates are planned for Quarkus 2 and features and bug fixes are not backported to the quarkus2 branch.
We have a GitHub action for backporting PRs between different branches. To use that, you must set a label named backport-<destination_branch_name>.
Let's say you want to backport a PR from the main branch to the quarkus2 branch. You would have to add a label named backport-quarkus2 to the original PR. When that PR is merged, the GitHub actions bot will send a copy of the PR to the quarkus2 branch.
See an example:
GitHub does not initiate checks for pull requests opened by the GitHub Actions bot. Therefore, when we backport a PR to another branch the PR checks are not run automatically.
We have a Kanban board, which is currently visible only by members of the Quarkiverse organization.
We have a GitHub action to automatically close issues and PRs that didn't have interactions for a while. If you want to disable it for a specific issue or PR, you can add the pinned label and it will never stale.