Code rules for SmallRye project family.
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 SmallRye 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.
The SmallRye projects use GitHub to manage the issues. Open an issue directly at the project's GitHub page.
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 SmallRye, Java, Maven and other relevant versions.
To contribute, use GitHub Pull Requests, from your own fork.
All submissions, including submissions by project members, need to be reviewed before being merged.
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.
Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc...).
If you have not done so on this machine, you need to:
- Install Git and configure your GitHub access
- Install Java SDK (OpenJDK recommended)
- Clone the SmallRye project from your previously created fork
SmallRye has a strictly enforced code style. Code formatting is done by the Eclipse code formatter, using the config files
found in the src/main/resources/io/smallrye/coderules directory.
By default when you run mvn 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 mvn process-sources.
Open the Preferences window, and then navigate to Java -> Code Style -> Formatter. Click Import and then select the src/main/resources/io/smallrye/coderules/eclipse-format.xml file in the src/main/resources/io/smallrye/coderules directory.
Next navigate to Java -> Code Style -> Organize Imports. Click Import and select the src/main/resources/io/smallrye/coderules/eclipse.importorder file.
Open the Preferences window, navigate to Plugins and install the Eclipse Code Formatter Plugin.
Restart you 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 src/main/resources/io/smallrye/coderules/eclipse-format.xml file in the src/main/resources/io/smallrye/coderules directory. Make sure the Optimize Imports box is ticked, and select the src/main/resources/io/smallrye/coderules/eclipse.importorder file as the import order config file.
All SmallRye projects are open source projects, please act responsibly, be nice, polite and enjoy!
Many thanks to the quarkus project where we "borrowed" most of the text for this page and used their Eclipse formatter as a starting point for the SmallRye formatter.