README.md

Self Puzzles

Self Puzzles module, version 0.0.9.

Contributing

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 guidelines.

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.

Maven Settings

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.

LICENSE

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.