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 version.
To contribute, use GitHub Pull Requests, from your own fork.
Also, make sure you have set up your Git authorship correctly:
git config --global user.name "Your Full Name"
git config --global user.email [email protected]We use this information to acknowledge your contributions in release announcements.
If you're considering anything more than correcting a typo or fixing a minor bug, please discuss it by creating an issue on our issue tracker before submitting a pull request. We're happy to provide guidance but please spend an hour or two researching the subject on your own including searching the forums for prior discussions.
This extension is compatible with native compilation. You can validate your changes early following Quarkus' documentation here, using either a builder image or a local installation of GraalVM.
# With GraalVM installed
mvn install -Dnative
# With a builder image
mvn install -Dnative -Dquarkus.native.container-build=trueAll submissions, need to be reviewed by at least one committer before being merged. Please properly squash your pull requests before submitting them.
GitHub Pull Request Review Process is followed for every pull request.
Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).
When creating a new Java file, make sure to manually add your Copyright in the header, otherwise Amadeus' Copyright will be automatically added. Ensure the following format to prevent it from being overridden:
/*-
* #%L
* Quarkus Kafka Streams Processor
* %%
* Copyright (C) [yyyy] [Your name]
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
Because we are all humans, and to ensure Quarkus is stable for everyone, all changes must go through Quarkus continuous integration. Quarkus CI is based on GitHub Actions, which means that everyone has the ability to automatically execute CI in their forks as part of the process of making changes. We ask that all non-trivial changes go through this process, so that the contributor gets immediate feedback, while at the same time keeping our CI fast and healthy for everyone.
The process requires only one additional step to enable Actions on your fork (clicking the green button in the actions tab). See the full video walkthrough for more details on how to do this.
here is the official documentation to release in a quakiverse repository.
To perform a release, one must provide a Pull-request changing the current-version and next-version properties in the .github/project.yml file.
Example:
release:
- current-version: "1.0.0"
- next-version: "1.1.0-SNAPSHOT"
+ current-version: "1.1.0"
+ next-version: "1.2.0-SNAPSHOT" Warning
- Don't merge another Pull-request during the pipeline following the merge of the release Pull-request
- The release Pull-request has to be created from the main repository