The Debezium community welcomes anyone that wants to help out in any way, whether that includes reporting problems, helping with documentation, or contributing code changes to fix bugs, add tests, or implement new features. This document outlines the basic steps required to work with and contribute to the Debezium Platform codebase.
Before doing any code changes, it's a good idea to reach out to us, so as to make sure there's a general consencus on the proposed change and the implementation strategy. You can reach us here:
- User chat
- Developers chat - Only for internal development subjects
- Google Group
- GitHub Issues
The following software is required to work with the Debezium codebase and build it locally:
- Git 2.2.1 or later
- JDK 21 or later, e.g. OpenJDK
- Apache Maven 3.9.8
- Docker Engine or Docker Desktop 1.9 or later
See the links above for installation instructions on your platform. You can verify the versions are installed and running:
$ git --version
$ javac -version
$ mvn -version
$ docker --version
Debezium uses GitHub for its primary code repository and for pull-requests, so if you don't already have a GitHub account you'll need to join.
Debezium uses the GitHub Issues instance for issue tracking.