Contributing
This section is for developers who change the Wanaku Capabilities Java SDK.
| Page | Contents |
|---|---|
| Write SDK documentation | Page conventions and the docs checks that CI runs. |
| Release guide | Cut a release from an X.Y.x branch. |
Build and test
The SDK uses Maven and Java 21. The project has no Maven wrapper.
bash
mvn clean install # build all modules
mvn test # run the unit tests
mvn verify -Pstatic-analysis # PMD and SpotBugs
mvn verify -Pcoverage # JaCoCo aggregate reportSpotless formats the code with Palantir Java Format in the compile phase. Wildcard imports are not permitted. Run the static analysis profile before you open a pull request.
Next steps
- Write SDK documentation: follow the page conventions.
- Release guide: release a new version.