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).
All original contributions to 1000kit 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.
This project uses Gitlab issues to manage the issues. Open an issue directly in Gitlab.
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.
Just do the following:
git clone git@gitlab.com:1000kit/libs/quarkus/tkit-quarkus.git
cd tkit-quarkus
export MAVEN_OPTS="-Xmx4g"
mvn -B impsort:check formatter:validate verify --file pom.xml
or use native profile -Pnative for native build and tests
mvn -B -Pnative impsort:check formatter:validate verify --file pom.xml
Wait for a bit and you're done.
Note For Apple Silicon computer, Rosetta must be installed. It can be done using softwareupdate --install-rosetta
When using the main branch, you need to use the group id org.tkit.quarkus.lib and version 999-SNAPSHOT of the 1000kit Quarkus BOM.
You can now test your application.
To contribute, use Gitlab Pull Requests, from your own branch feat/<name-of-feature>.
Also, make sure you have set up your Git authorship correctly:
git config --global user.name "Your Full Name"
git config --global user.email your.email@example.com
If you use different computers to contribute, please make sure the name is the same on all your computers.
We use this information to acknowledge your contributions in release announcements.
All submissions, including submissions by project members, need to be reviewed by at least one Quarkus committer before being merged.
GitHub Pull Request Review Process is followed for every pull request.
- We decided to disallow
@authortags in the Javadoc: they are hard to maintain, especially in a very active project, and we use the Git history to track authorship. Gitlab also has this nice page with your contributions. For each major 1000kit Quarkus extensions release, we also publish the list of contributors in the announcement post. - Commits should be atomic and semantic. Please properly squash your pull requests before submitting them. Fix-up commits can be used temporarily during the review process but things should be squashed at the end to have meaningful commits. We use merge commits so the Gitlab Merge button cannot do that for us. If you don't know how to do that, just ask in your pull request, we will be happy to help!
Because we are all humans, and to ensure 1000kit Quarkus extension is stable for everyone, all changes must go through 1000kit Quarkus extension continuous integration. 1000kit Quarkus extension CI is based on Gitlab pipelines, 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.
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:
- Update imports and format
mvn -B clean impsort:sort formatter:format - Java mode
mvn -B impsort:check formatter:validate verify --file pom.xml - Native mode
mvn -B -Pnative impsort:check formatter:validate verify --file pom.xml