Developers Guide

Overview

Contributions to dbUnit are welcome. This page is the map for the rest of the "Developing DbUnit" section — a fast-path checklist if you’re new, and a set of links to the focused page for whatever you need next.

Contributor Quick Start

  1. Fork the repository and branch from main — see Branching & Pull Requests.
  2. Write the code and the tests that cover it — see Test Conventions.
  3. Format it — see Coding Standards.
  4. Commit, following the Conventional Commits format, bundling the changes.xml entry in the same commit — see Commit Requirements and Changelog.
  5. Push and open a pull request — see Branching & Pull Requests.

Where to Go Next

Coding Standards
General Java style, JavaDoc conventions, and dbUnit’s own test-writing conventions, plus the tooling (Eclipse formatter, Checkstyle, Modernizer) that partially automates and enforces them.
Commit Requirements
Atomic commits, the same-commit bundling rules, the fixup!/autosquash workflow, and the full Conventional Commits format.
Changelog
The changes.xml schema, placement rules, and the Dependabot automation that handles routine dependency bumps for you.
GitHub Workflow
Filing issues, the branch/PR process, and the CI workflows that watch your branch.
Building
Generating the jar and the site, and the quality gates (Checkstyle, Modernizer, JaCoCo, japicmp) that run along the way.
Integration Tests
Running the test suite against a specific database, in an IDE, or against every supported database at once.
Releasing
The maintainer-facing release procedure.

Discussions and Questions

For questions, assistance, or other help, comment on the relevant issue or pull request, or start a GitHub Discussion.