Contributing to sai-java

Thanks for your interest in sai-java. Feedback, questions, issues, and contributions are both welcomed and encouraged.

Getting Started

A thorough understanding of the Solid Application Interoperability Specification implemented by this library is essential to any substantive contributions.

For those interested in contributing to the specification, please consider participating in the Solid Interoperability Panel.

Contributions to sai-java should be made in the form of pull requests. Each pull request will be reviewed by one or more core contributors.

To build from source:

$ mvn compile

To build with code coverage:

$ mvn verify

To run tests:

$ mvn test

To generate site and documentation (output in ./target/site/):

$ mvn site

JavaDocs are generated and published with each release.

Releases are performed by the Maven Release Plugin as part of Github Actions. They must be triggered manually via the Publish Release Workflow.

Choose Run workflow
Adjust settings for the maven release
- Use workflow from: Brain: main
- Minor version increment: true if a minor version increment (1.0.0 -> 1.1.0) is desired
- Major version increment: true if a major version increment (1.0.0 -> 2.0.0) is desired
Adjust settings for the Github release
- Is this a draft (not finalized) release? true if the github release should be saved in draft form
- Is this a prerelease? true if this is not meant to be a production ready public release
- Release summary: Textual summary of the release
Click the green Run workflow button

This will result in: