Skip to main content

Contributing

Bug reports, documentation fixes and code changes are welcome. The full guide is CONTRIBUTING.md; this page is the short version.

Where to go​

You haveGo to
A bugBug report, ideally with a failing test
A feature ideaAn issue first, to agree on the approach before writing code
A security issueSupport Policy, never a public issue

Building​

You need JDK 21 and Docker (tests start the databases and brokers with Testcontainers). Maven comes with the wrapper:

./mvnw clean install -Dgpg.skip=true

The infrastructure integration tests, the end-to-end tests and the classpath isolation tests live in oncebox-tests/ outside the reactor and run after it is installed; the commands are in CONTRIBUTING.md.

Ground rules​

  • One change per pull request, with tests; a bug fix comes with a test that fails without it.
  • SQL changes go to all three dialect modules, and schema changes are synced to oncebox-test-fixtures.
  • A schema change is a new migration for every dialect, never an edit of a released one. One script runs under Flyway, Liquibase and DEV at once; follow the rules in Writing a migration.
  • A user-visible change updates the documentation.

Documentation​

This site lives in its own repository, oncebox-docs, and is built with Docusaurus. To preview a change:

git clone https://github.com/dmitriy-iliyov/oncebox-docs.git
cd oncebox-docs
npm ci
npm start

Every page has an "Edit this page" link at the bottom that opens it on GitHub.