Contribution guidelines
DataStax Zero Downtime Migration (ZDM) provides a simple and reliable way for users to migrate an existing Apache Cassandra® or DataStax Enterprise cluster to Astra DB, or to any Cassandra/DSE cluster, without any interruption of service to the client applications and data.
The ZDM Proxy is open source software (OSS). We welcome contributions from the developer community via Pull Requests on a fork, for evaluation by the ZDM team.
The code sources for additional Zero Downtime Migration components — including ZDM Utility, ZDM Proxy Automation, Cassandra Data Migrator, and DSBulk Migrator — are available in public GitHub repos, where you may submit feedback and ideas via GitHub Issues. Code contributions for those additional components are not open for PRs at this time.
ZDM Proxy License
ZDM Proxy is licensed under the open-source Apache-2.0 license agreement.
Contributor License Agreement
Acceptance of the DataStax Contributor License Agreement (CLA) is required before we can consider accepting your ZDM Proxy code contribution. Refer to the CLA terms and, if you agree, indicate your acceptance on each Pull Request (PR) that you submit while using the ZDM Proxy GitHub repository.
ZDM Proxy code contributions
The overall procedure:
-
Start on the open-source public repo, https://github.com/datastax/zdm-proxy/.
-
Fork the repo by clicking the Fork button in the GitHub UI.
-
Make your changes locally on your fork. Git commit and push only to your fork.
-
Wait for CI to run successfully in GitHub Actions before submitting a PR.
-
Submit a Pull Request (PR) with your forked updates. As noted above, be sure to indicate in the PR’s Comments your acceptance (if you agree) with the DataStax Contributor License Agreement (CLA).
-
If you’re not yet ready for a review, add "WIP" to the PR name to indicate it’s a work in progress.
-
Wait for the automated PR workflow to do some checks. Members of the ZDM Proxy community will review your PR and decide whether to approve and merge it.
In addition to potential ZDM Proxy OSS code contribution, we encourage you to submit feedback and ideas via GitHub Issues in the repo, starting from https://github.com/datastax/zdm-proxy/issues. Add a label to help categorize the issue, such as the complexity level, component name, and other labels you’ll find in the repo’s Issues display.
Submitting GitHub Issues in related public repos
The following DataStax Zero Downtime Migration GitHub repos are public. You are welcome to read the source and submit feedback and ideas via GitHub Issues per repo. In addition to the ZDM Proxy open-source repo, refer to:
-
ZDM Proxy Automation repo for Ansible-based ZDM Proxy Automation and ZDM Utility.
-
Cassandra Data Migrator repo.
-
DSBulk Migrator repo.
Again, add a label to help categorize each issue, such as the complexity level, component name, and other labels you’ll find in the repo’s Issues display.
