We welcome contributions, and request you follow these guidelines.
Please raise any bug reports on the issue tracker. Be sure to search the list to see if your issue has already been raised.
A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.
In order to make contribution as easy as possible, we follow the same approach as the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.
We simply ask that when submitting a pull request for review, the developer must include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -sThis project contains a CI build that should run successfully. Upon opening a Pull Request or Merging a commit this build will run. If your Pull Request results in the failure of this build it will not be reviewed or merged until the failure is fixed.
- JDK 11 or higher
- Any container engine, e.g. Docker, Podman, Colima. As this project is build on top of testcontainers, see their documentation on how to use another container engine than Docker by default.
Use the gradle wrapper to build this project:
./gradlew build