Want to contribute to the RESTEasy? We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, etc. First though, please read this page (including the small print at the end).
All original contributions to RESTEasy 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](dco.txt) file in the root directory of the repository.
This project uses JIRA for filing issues. An account is required, However, if you do not wish to signup for an account, you can open a discussion and we will assist you in filing an issue.
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.
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 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.
If you have not done so on this machine, you need to:
-
Install Git and configure your GitHub access
-
Install Java SDK 11+ (OpenJDK recommended)
RESTEasy has a strictly enforced code style. Code formatting is done by the Eclipse code formatter, using the config files
found in the eclipse-code-formatter.xml
file. 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.
Open the Preferences window, and then navigate to Java → Code Style → Formatter. Click Import and then
select the eclipse-code-formatter.xml downloaded from the above link or clone the repository and navigate to the file.
Next navigate to Java → Code Style → Organize Imports. Click Import and select the eclipse.importorder file.
Install the Adapter for Eclipse Code Formatter. See the documentation on how to configure the plugin.