If you would like to contribute, just open an issue or a PR.
You will need Java 11. Make sure the maven build:
$mvn clean install -Pcheckstyle,itcases
passes before making a PR. Checkstyle will make sure you're following our code style and guidlines.
It's better to make changes on a separate branch (derived from master), so you won't have to cherry pick commits in case your PR is rejected.
This project depends on jars from Self's Github Packages server. This server
requires authentication so, in order for Maven to be able to fetch dependencies,
you need to specify your credentials in Maven's settings.xml:
<settings>
...
<servers>
<server>
<id>github</id>
<username>yourGithubUsername</username>
<password>your_github_token</password>
</server>
</servers>
</settings>Make sure you generate a token with the appropriate
permissions. The settings.xml file usually resides on your computer at ${user.home}/.m2/settings.xml.
If the file is not there, you can create it.
Some of the tickets have a cash bounty assigned to them. If you want to solve a ticket and get the bounty, tell me and I'll assign it to you. You will have 10 days to provide a PR and close the ticket. Pay attention: if the 10 days pass, I might take it away from you and give it to someone else -- if this happens, you won't get any cash.
You don't have to solve the whole ticket! Many times, it will happen that the ticket requires more effort than what the bounty is worth. If this is the case, solve the ticket only partially and leave "todo" markers in the code -- these will automatically be transformed into Github Issues. However, you will have to leave the code in a consistent state, the build has to pass always.
More details here.
This product's code is open source. However, the LICENSE only allows you to read the code. Copying, downloading or forking the repo is strictly forbidden unless you are one of the project's contributors.