We have a guide for this: CONTRIBUTING.md

See the Nuun documentation.

The package name conventions are the following.

• All the API in a module should be under a package named org.seedstack.modulename, for instance org.seedstack.security or org.seedstack.business.

• If an SPI is provided, it should be placed in a package org.seedstack.modulename.spi.

• All the internal classes should be under org.seedstack.modulename.internal. The internal package should be as flat as possible. These classes will be hidden in Java 9 and for now they should use the package visibility.

• A package org.seedstack.modulename.utils can also be used when necessary. But should be avoided when possible.

org.seedstack.modulename
org.seedstack.modulename.spi
org.seedstack.modulename.internal

If you are build an addons which is not part of the seedstack distribution replace the prefix org.seedstack by your own. But the conventions stay the same.

• Usually it's because you forget to add the license header in your file. In this case run this command:

mvn license:format

• But it can also be caused by dependency with forbidden license. In this case try to avoid to include the problematic dependency or come ask us on IRC at #seedstack-dev.

• If the problem correspond to a project which use the SeedStack parent but which is not destined to be published, you can disable the license check by adding the following config to your pom.

<build>
    <pluginManagement>
        <plugins>
           <plugin>
               <groupId>com.mycila</groupId>
               <artifactId>license-maven-plugin</artifactId>
               <executions>
                   <execution>
                       <id>check-license-header</id>
                       <phase>none</phase>
                   </execution>
                </executions>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

It's always a pleasure to check the test count of your project. You can do so with the following one-line (provided that you have the awesome ack tool):

ack --java -c -l "@Test" | cut -d':' -f2 | awk '{x+=$0}END{print x}'