Skip to content

Update README and CONTRIBUTING for new maintainership#17

Merged
renecannao merged 2 commits intomasterfrom
phase1/task8-docs-update
Mar 23, 2026
Merged

Update README and CONTRIBUTING for new maintainership#17
renecannao merged 2 commits intomasterfrom
phase1/task8-docs-update

Conversation

@renecannao
Copy link
Copy Markdown

Summary

  • Removed the "end of dbdeployer" notice from README.md and added a "New Maintainer" section explaining the project is now actively maintained by the ProxySQL team, with roadmap highlights and a link to the Phase 1 milestone
  • Added a "Development Setup" section to CONTRIBUTING.md with Go 1.22+ requirement and golangci-lint instructions
  • Updated issue tracker and badge links to point to ProxySQL/dbdeployer

Closes #8

Test plan

  • Verify README.md renders correctly on GitHub
  • Verify CONTRIBUTING.md renders correctly on GitHub
  • Confirm milestone link resolves properly

Copilot AI review requested due to automatic review settings March 23, 2026 19:11
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates project documentation to reflect new maintainership under the ProxySQL organization, and refreshes the Go toolchain/dependencies accordingly.

Changes:

  • README: remove “end of dbdeployer” notice; add “New Maintainer” + roadmap; update repo/badge links.
  • CONTRIBUTING: add development setup notes (Go 1.22+; golangci-lint guidance) and update issue tracker link.
  • Go module: bump minimum Go version to 1.22 and update dependency set (go.mod/go.sum); remove an obsolete build tag from an embedded-registry file.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
go.mod Raises Go version to 1.22 and bumps multiple dependencies.
go.sum Updates checksums to match the refreshed dependency graph.
downloads/tarball_registry.go Removes a Go 1.16 build constraint header.
README.md Updates maintainership messaging and adjusts links/badge.
CONTRIBUTING.md Adds development setup section and updates issue tracker link.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md
## Development Setup

- **Go 1.22+** is required to build and test dbdeployer.
- **[golangci-lint](https://golangci-lint.run/)** is required for linting:
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CONTRIBUTING says golangci-lint is "required", but there’s no golangci-lint config in the repo and CI doesn’t appear to run it. To avoid contributor confusion, either add/configure golangci-lint (and enforce it in CI) or soften the wording to make it optional/recommended.

Suggested change
- **[golangci-lint](https://golangci-lint.run/)** is required for linting:
- **[golangci-lint](https://golangci-lint.run/)** is recommended for linting (optional):

Copilot uses AI. Check for mistakes.
Comment thread README.md Outdated
[DBdeployer](https://github.com/datacharmer/dbdeployer) is a tool that deploys MySQL database servers easily.

[DBdeployer](https://github.com/ProxySQL/dbdeployer) is a tool that deploys MySQL database servers easily.
This is a port of [MySQL-Sandbox](https://github.com/datacharmer/mysql-sandbox), originally written in Perl, and re-designed from the ground up in [Go](https://golang.org). See the [features comparison](https://github.com/datacharmer/dbdeployer/blob/master/docs/features.md) for more detail.
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "features comparison" link still points to the old datacharmer repository/branch (github.com/datacharmer/dbdeployer/blob/master/...). Since the README now identifies ProxySQL/dbdeployer as the canonical repo, this link should be updated (or made relative) to avoid sending readers to an outdated fork/branch.

Suggested change
This is a port of [MySQL-Sandbox](https://github.com/datacharmer/mysql-sandbox), originally written in Perl, and re-designed from the ground up in [Go](https://golang.org). See the [features comparison](https://github.com/datacharmer/dbdeployer/blob/master/docs/features.md) for more detail.
This is a port of [MySQL-Sandbox](https://github.com/datacharmer/mysql-sandbox), originally written in Perl, and re-designed from the ground up in [Go](https://golang.org). See the [features comparison](docs/features.md) for more detail.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Documentation updated for version 1.66.0 (26-Jul-2022 10:30 UTC)

![Build Status](https://github.com/datacharmer/dbdeployer/workflows/.github/workflows/all_tests.yml/badge.svg)
![Build Status](https://github.com/ProxySQL/dbdeployer/workflows/.github/workflows/all_tests.yml/badge.svg)
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build status badge URL format looks incorrect for GitHub Actions (it uses /workflows/.github/workflows/all_tests.yml/badge.svg). Consider switching to the supported badge endpoint under /actions/workflows/<workflow_file>/badge.svg (optionally with a branch query) so the badge renders reliably.

Suggested change
![Build Status](https://github.com/ProxySQL/dbdeployer/workflows/.github/workflows/all_tests.yml/badge.svg)
![Build Status](https://github.com/ProxySQL/dbdeployer/actions/workflows/all_tests.yml/badge.svg)

Copilot uses AI. Check for mistakes.
Comment thread go.mod
module github.com/datacharmer/dbdeployer

go 1.18
go 1.22
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

go.mod now declares Go 1.22, but the GitHub Actions workflow in this repo still sets up Go ^1.18. Unless CI is updated accordingly, the build/test job will likely fail (or use an unintended toolchain). Please align CI (and any scripts) with the new minimum Go version, or lower the go directive if 1.22 is not required.

Suggested change
go 1.22
go 1.18

Copilot uses AI. Check for mistakes.
Comment thread go.mod
Comment on lines +6 to +15
github.com/alexeyco/simpletable v1.0.0
github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de
github.com/dustin/go-humanize v1.0.1
github.com/go-sql-driver/mysql v1.7.1
github.com/nightlyone/lockfile v1.0.0
github.com/pkg/errors v0.9.1
github.com/rogpeppe/go-internal v1.9.0
github.com/spf13/cobra v1.4.0
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.0
github.com/rogpeppe/go-internal v1.12.0
github.com/spf13/cobra v1.8.1
github.com/spf13/pflag v1.0.6
github.com/stretchr/testify v1.9.0
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR’s description focuses on documentation/maintainership updates, but go.mod also bumps multiple direct dependencies (cobra, mysql driver, testify, x/*). If that dependency refresh is intentional, it would help to call it out explicitly in the PR description (or split into a separate PR) because it changes the risk/rollback profile beyond docs.

Copilot uses AI. Check for mistakes.
@renecannao
Copy link
Copy Markdown
Author

@gemini-code-assist review

@renecannao
Copy link
Copy Markdown
Author

@claude review

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the project's documentation and configuration to reflect the new maintainership under the ProxySQL team. The changes include updating the README and CONTRIBUTING files with new information, development setup instructions, and updated links. The Go module is also updated to version 1.22 along with its dependencies.

My review has identified a couple of important issues:

  • The Go module path in go.mod has not been updated to the new repository location (github.com/ProxySQL/dbdeployer). This is a critical issue that affects dependency management.
  • The README.md file was edited directly, but the project's contribution guidelines state that it should be generated from a template. This means the changes will be lost on the next generation.

Please address these points to ensure the project is correctly set up under its new maintainership.

Comment thread go.mod
@@ -1,41 +1,39 @@
module github.com/datacharmer/dbdeployer
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

Since the repository has been moved to ProxySQL/dbdeployer, the module path should be updated to reflect the new location. This is crucial for Go's dependency management to correctly resolve the module.

Without this change, go get and other Go tools will still fetch the module from the old datacharmer location.

After changing the module path, you will also need to update all internal import paths throughout the project to use the new module path. This can be a significant change, but it's necessary for the project's long-term health under new maintainership.

Suggested change
module github.com/datacharmer/dbdeployer
module github.com/ProxySQL/dbdeployer

Comment thread README.md
Comment on lines 1 to +85
# dbdeployer
[DBdeployer](https://github.com/datacharmer/dbdeployer) is a tool that deploys MySQL database servers easily.
This is a port of [MySQL-Sandbox](https://github.com/datacharmer/mysql-sandbox), originally written in Perl, and re-designed from the ground up in [Go](https://golang.org). See the [features comparison](https://github.com/datacharmer/dbdeployer/blob/master/docs/features.md) for more detail.

Documentation updated for version 1.66.0 (26-Jul-2022 10:30 UTC)
[DBdeployer](https://github.com/ProxySQL/dbdeployer) is a tool that deploys MySQL database servers easily.
This is a port of [MySQL-Sandbox](https://github.com/datacharmer/mysql-sandbox), originally written in Perl, and re-designed from the ground up in [Go](https://golang.org). See the [features comparison](https://github.com/ProxySQL/dbdeployer/blob/master/docs/features.md) for more detail.

## New Maintainer

As of 2026, dbdeployer is actively maintained by the [ProxySQL](https://github.com/ProxySQL) team, with the blessing of the original creator [Giuseppe Maxia](https://github.com/datacharmer). We are grateful for Giuseppe's years of work on this project.

**Roadmap:**
- Modern MySQL support (8.4 LTS, 9.x Innovation releases)
- ProxySQL and Orchestrator integration as deployment providers
- Provider-based architecture for extensibility
- PostgreSQL support (long-term)

See the [Phase 1 milestone](https://github.com/ProxySQL/dbdeployer/milestone/1) for current progress.

Documentation updated for version 1.74.0 (23-Mar-2026)

![Build Status](https://github.com/datacharmer/dbdeployer/workflows/.github/workflows/all_tests.yml/badge.svg)
![Build Status](https://github.com/ProxySQL/dbdeployer/workflows/.github/workflows/all_tests.yml/badge.svg)

- [Installation](https://github.com/datacharmer/dbdeployer/wiki/installation)
- [Manual installation](https://github.com/datacharmer/dbdeployer/wiki/installation#manual-installation)
- [Installation via script](https://github.com/datacharmer/dbdeployer/wiki/installation#installation-via-script)
- [Prerequisites](https://github.com/datacharmer/dbdeployer/wiki/prerequisites)
- [Initializing the environment](https://github.com/datacharmer/dbdeployer/wiki/initializing-the-environment)
- [Updating dbdeployer](https://github.com/datacharmer/dbdeployer/wiki/updating-dbdeployer)
- [Main operations](https://github.com/datacharmer/dbdeployer/wiki/main-operations)
- [Overview](https://github.com/datacharmer/dbdeployer/wiki/main-operations#overview)
- [Unpack](https://github.com/datacharmer/dbdeployer/wiki/main-operations#unpack)
- [Deploy single](https://github.com/datacharmer/dbdeployer/wiki/main-operations#deploy-single)
- [Deploy multiple](https://github.com/datacharmer/dbdeployer/wiki/main-operations#deploy-multiple)
- [Deploy replication](https://github.com/datacharmer/dbdeployer/wiki/main-operations#deploy-replication)
- [Re-deploy a sandbox](https://github.com/datacharmer/dbdeployer/wiki/main-operations#re-deploy-a-sandbox)
- [Database users](https://github.com/datacharmer/dbdeployer/wiki/database-users)
- [Database server flavors](https://github.com/datacharmer/dbdeployer/wiki/database-server-flavors)
- [Getting remote tarballs](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs)
- [Looking at the available tarballs](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#looking-at-the-available-tarballs)
- [Getting a tarball](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#getting-a-tarball)
- [Customizing the tarball list](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#customizing-the-tarball-list)
- [Changing the tarball list permanently](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#changing-the-tarball-list-permanently)
- [From remote tarball to ready to use in one step](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#from-remote-tarball-to-ready-to-use-in-one-step)
- [Guessing the latest MySQL version](https://github.com/datacharmer/dbdeployer/wiki/getting-remote-tarballs#guessing-the-latest-mysql-version)
- [Practical examples](https://github.com/datacharmer/dbdeployer/wiki/practical-examples)
- [Standard and non-standard basedir names](https://github.com/datacharmer/dbdeployer/wiki/standard-and-non-standard-basedir-names)
- [Using short version numbers](https://github.com/datacharmer/dbdeployer/wiki/using-short-version-numbers)
- [Multiple sandboxes, same version and type](https://github.com/datacharmer/dbdeployer/wiki/multiple-sandboxes,-same-version-and-type)
- [Using the direct path to the expanded tarball](https://github.com/datacharmer/dbdeployer/wiki/using-the-direct-path-to-the-expanded-tarball)
- [Ports management](https://github.com/datacharmer/dbdeployer/wiki/ports-management)
- [Concurrent deployment and deletion](https://github.com/datacharmer/dbdeployer/wiki/concurrent-deployment-and-deletion)
- [Replication topologies](https://github.com/datacharmer/dbdeployer/wiki/replication-topologies)
- [Skip server start](https://github.com/datacharmer/dbdeployer/wiki/skip-server-start)
- [MySQL Document store, mysqlsh, and defaults.](https://github.com/datacharmer/dbdeployer/wiki/mysql-document-store,-mysqlsh,-and-defaults.)
- [Installing MySQL shell](https://github.com/datacharmer/dbdeployer/wiki/installing-mysql-shell)
- [Database logs management.](https://github.com/datacharmer/dbdeployer/wiki/database-logs-management.)
- [dbdeployer operations logging](https://github.com/datacharmer/dbdeployer/wiki/dbdeployer-operations-logging)
- [Sandbox customization](https://github.com/datacharmer/dbdeployer/wiki/sandbox-customization)
- [Sandbox management](https://github.com/datacharmer/dbdeployer/wiki/sandbox-management)
- [Sandbox macro operations](https://github.com/datacharmer/dbdeployer/wiki/sandbox-macro-operations)
- [dbdeployer global exec](https://github.com/datacharmer/dbdeployer/wiki/sandbox-macro-operations#dbdeployer-global-exec)
- [dbdeployer global use](https://github.com/datacharmer/dbdeployer/wiki/sandbox-macro-operations#dbdeployer-global-use)
- [Sandbox deletion](https://github.com/datacharmer/dbdeployer/wiki/sandbox-deletion)
- [Default sandbox](https://github.com/datacharmer/dbdeployer/wiki/default-sandbox)
- [Using the latest sandbox](https://github.com/datacharmer/dbdeployer/wiki/using-the-latest-sandbox)
- [Sandbox upgrade](https://github.com/datacharmer/dbdeployer/wiki/sandbox-upgrade)
- [Dedicated admin address](https://github.com/datacharmer/dbdeployer/wiki/dedicated-admin-address)
- [Loading sample data into sandboxes](https://github.com/datacharmer/dbdeployer/wiki/loading-sample-data-into-sandboxes)
- [Running sysbench](https://github.com/datacharmer/dbdeployer/wiki/running-sysbench)
- [Obtaining sandbox metadata](https://github.com/datacharmer/dbdeployer/wiki/obtaining-sandbox-metadata)
- [Replication between sandboxes](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes)
- [a. NDB to NDB](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes#a.-ndb-to-ndb)
- [b. Group replication to group replication](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes#b.-group-replication-to-group-replication)
- [c. Master/slave to master/slave.](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes#c.-master/slave-to-master/slave.)
- [d. Hybrid replication](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes#d.-hybrid-replication)
- [e. Cloning](https://github.com/datacharmer/dbdeployer/wiki/replication-between-sandboxes#e.-cloning)
- [Using dbdeployer in scripts](https://github.com/datacharmer/dbdeployer/wiki/using-dbdeployer-in-scripts)
- [Importing databases into sandboxes](https://github.com/datacharmer/dbdeployer/wiki/importing-databases-into-sandboxes)
- [Cloning databases](https://github.com/datacharmer/dbdeployer/wiki/cloning-databases)
- [Compiling dbdeployer](https://github.com/datacharmer/dbdeployer/wiki/compiling-dbdeployer)
- [Generating additional documentation](https://github.com/datacharmer/dbdeployer/wiki/generating-additional-documentation)
- [Command line completion](https://github.com/datacharmer/dbdeployer/wiki/command-line-completion)
- [Using dbdeployer source for other projects](https://github.com/datacharmer/dbdeployer/wiki/using-dbdeployer-source-for-other-projects)
- [Exporting dbdeployer structure](https://github.com/datacharmer/dbdeployer/wiki/exporting-dbdeployer-structure)
- [Semantic versioning](https://github.com/datacharmer/dbdeployer/wiki/semantic-versioning)
- [Do not edit](https://github.com/datacharmer/dbdeployer/wiki/do-not-edit)
- [Installation](https://github.com/ProxySQL/dbdeployer/wiki/installation)
- [Manual installation](https://github.com/ProxySQL/dbdeployer/wiki/installation#manual-installation)
- [Installation via script](https://github.com/ProxySQL/dbdeployer/wiki/installation#installation-via-script)
- [Prerequisites](https://github.com/ProxySQL/dbdeployer/wiki/prerequisites)
- [Initializing the environment](https://github.com/ProxySQL/dbdeployer/wiki/initializing-the-environment)
- [Updating dbdeployer](https://github.com/ProxySQL/dbdeployer/wiki/updating-dbdeployer)
- [Main operations](https://github.com/ProxySQL/dbdeployer/wiki/main-operations)
- [Overview](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#overview)
- [Unpack](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#unpack)
- [Deploy single](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#deploy-single)
- [Deploy multiple](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#deploy-multiple)
- [Deploy replication](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#deploy-replication)
- [Re-deploy a sandbox](https://github.com/ProxySQL/dbdeployer/wiki/main-operations#re-deploy-a-sandbox)
- [Database users](https://github.com/ProxySQL/dbdeployer/wiki/database-users)
- [Database server flavors](https://github.com/ProxySQL/dbdeployer/wiki/database-server-flavors)
- [Getting remote tarballs](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs)
- [Looking at the available tarballs](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#looking-at-the-available-tarballs)
- [Getting a tarball](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#getting-a-tarball)
- [Customizing the tarball list](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#customizing-the-tarball-list)
- [Changing the tarball list permanently](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#changing-the-tarball-list-permanently)
- [From remote tarball to ready to use in one step](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#from-remote-tarball-to-ready-to-use-in-one-step)
- [Guessing the latest MySQL version](https://github.com/ProxySQL/dbdeployer/wiki/getting-remote-tarballs#guessing-the-latest-mysql-version)
- [Practical examples](https://github.com/ProxySQL/dbdeployer/wiki/practical-examples)
- [Standard and non-standard basedir names](https://github.com/ProxySQL/dbdeployer/wiki/standard-and-non-standard-basedir-names)
- [Using short version numbers](https://github.com/ProxySQL/dbdeployer/wiki/using-short-version-numbers)
- [Multiple sandboxes, same version and type](https://github.com/ProxySQL/dbdeployer/wiki/multiple-sandboxes,-same-version-and-type)
- [Using the direct path to the expanded tarball](https://github.com/ProxySQL/dbdeployer/wiki/using-the-direct-path-to-the-expanded-tarball)
- [Ports management](https://github.com/ProxySQL/dbdeployer/wiki/ports-management)
- [Concurrent deployment and deletion](https://github.com/ProxySQL/dbdeployer/wiki/concurrent-deployment-and-deletion)
- [Replication topologies](https://github.com/ProxySQL/dbdeployer/wiki/replication-topologies)
- [Skip server start](https://github.com/ProxySQL/dbdeployer/wiki/skip-server-start)
- [MySQL Document store, mysqlsh, and defaults.](https://github.com/ProxySQL/dbdeployer/wiki/mysql-document-store,-mysqlsh,-and-defaults.)
- [Installing MySQL shell](https://github.com/ProxySQL/dbdeployer/wiki/installing-mysql-shell)
- [Database logs management.](https://github.com/ProxySQL/dbdeployer/wiki/database-logs-management.)
- [dbdeployer operations logging](https://github.com/ProxySQL/dbdeployer/wiki/dbdeployer-operations-logging)
- [Sandbox customization](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-customization)
- [Sandbox management](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-management)
- [Sandbox macro operations](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-macro-operations)
- [dbdeployer global exec](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-macro-operations#dbdeployer-global-exec)
- [dbdeployer global use](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-macro-operations#dbdeployer-global-use)
- [Sandbox deletion](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-deletion)
- [Default sandbox](https://github.com/ProxySQL/dbdeployer/wiki/default-sandbox)
- [Using the latest sandbox](https://github.com/ProxySQL/dbdeployer/wiki/using-the-latest-sandbox)
- [Sandbox upgrade](https://github.com/ProxySQL/dbdeployer/wiki/sandbox-upgrade)
- [Dedicated admin address](https://github.com/ProxySQL/dbdeployer/wiki/dedicated-admin-address)
- [Loading sample data into sandboxes](https://github.com/ProxySQL/dbdeployer/wiki/loading-sample-data-into-sandboxes)
- [Running sysbench](https://github.com/ProxySQL/dbdeployer/wiki/running-sysbench)
- [Obtaining sandbox metadata](https://github.com/ProxySQL/dbdeployer/wiki/obtaining-sandbox-metadata)
- [Replication between sandboxes](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes)
- [a. NDB to NDB](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes#a.-ndb-to-ndb)
- [b. Group replication to group replication](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes#b.-group-replication-to-group-replication)
- [c. Master/slave to master/slave.](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes#c.-master/slave-to-master/slave.)
- [d. Hybrid replication](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes#d.-hybrid-replication)
- [e. Cloning](https://github.com/ProxySQL/dbdeployer/wiki/replication-between-sandboxes#e.-cloning)
- [Using dbdeployer in scripts](https://github.com/ProxySQL/dbdeployer/wiki/using-dbdeployer-in-scripts)
- [Importing databases into sandboxes](https://github.com/ProxySQL/dbdeployer/wiki/importing-databases-into-sandboxes)
- [Cloning databases](https://github.com/ProxySQL/dbdeployer/wiki/cloning-databases)
- [Compiling dbdeployer](https://github.com/ProxySQL/dbdeployer/wiki/compiling-dbdeployer)
- [Generating additional documentation](https://github.com/ProxySQL/dbdeployer/wiki/generating-additional-documentation)
- [Command line completion](https://github.com/ProxySQL/dbdeployer/wiki/command-line-completion)
- [Using dbdeployer source for other projects](https://github.com/ProxySQL/dbdeployer/wiki/using-dbdeployer-source-for-other-projects)
- [Exporting dbdeployer structure](https://github.com/ProxySQL/dbdeployer/wiki/exporting-dbdeployer-structure)
- [Semantic versioning](https://github.com/ProxySQL/dbdeployer/wiki/semantic-versioning)
- [Do not edit](https://github.com/ProxySQL/dbdeployer/wiki/do-not-edit)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

According to CONTRIBUTING.md, this README.md file is generated from mkreadme/readme_template.md and should not be edited directly. Your changes will be lost the next time the README is generated.

Please apply your changes to mkreadme/readme_template.md and then run ./mkreadme/build_readme.sh to regenerate README.md.

Also, when you move the changes to the template, please double-check the year in 'As of 2026', as it seems to be a typo referring to a future date.

@renecannao
Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

Warning

Rate limit exceeded

@renecannao has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 32 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b77402c-bbb4-4421-9f59-314f595486b4

📥 Commits

Reviewing files that changed from the base of the PR and between 35df06d and 0c1827a.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch phase1/task8-docs-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@renecannao renecannao force-pushed the phase1/task8-docs-update branch from faab716 to 0c1827a Compare March 23, 2026 20:18
@renecannao renecannao merged commit 085b4f9 into master Mar 23, 2026
0 of 5 checks passed
@renecannao renecannao deleted the phase1/task8-docs-update branch March 23, 2026 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README and CONTRIBUTING for new maintainership

2 participants