Development¶

This page contains information for developers about how to contribute to this project.

Requirements¶

Inside the bagit-java root directory, run mvn verify.

When extending the library follow the established patterns, to keep it easy to understand for any new user.

Since this is a library, the JavaDocs should be relatively extensive, although there is no need to go overboard with this. At a minimum:

The JavaDocs must be generated successfully. As of today this is a standard part of the build; the build will fail if doc generation fails.
Every API endpoint method needs JavaDocs that documents the parameters and exceptions and has a deep link to the Dataverse docs for the end-point that is called. This must be a link to target "_blank". See existing code for examples.
If an example program for the end-point method is available (which should be the case) also add a deep link to (the latest commit of) the example code.
Run the documentation site locally to check how it renders.