Skip to content

Commit 6e7a202

Browse files
committed
docs: update README and CONTRIBUTING for new maintainership
1 parent 0ca17ee commit 6e7a202

2 files changed

Lines changed: 22 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@ dbdeployer is open source, and as such contributions are welcome.
44

55
The following guidelines want to help and simplify the process of contributing to dbdeployer development.
66

7+
## Development Setup
8+
9+
- **Go 1.22+** is required to build and test dbdeployer.
10+
- **[golangci-lint](https://golangci-lint.run/)** is required for linting. Install it following the [official instructions](https://golangci-lint.run/welcome/install/) and run `golangci-lint run` before submitting a PR.
11+
712
## Principles
813

9-
1. Contributions should follow the classic GitHub workflow, i.e. forking, cloning, then submitting a Pull Request (PR)
14+
1. Contributions should follow the classic GitHub workflow, i.e. forking, cloning, then submitting a Pull Request (PR)
1015
with the code that you propose.
11-
2. Every new feature or bug fix should have an [issue](https://github.com/datacharmer/dbdeployer/issues), where the
16+
2. Every new feature or bug fix should have an [issue](https://github.com/ProxySQL/dbdeployer/issues), where the
1217
improvement gets discussed before any code is written.
1318
3. If the contribution is a quick fix, such as a grammar or spelling mistake, go right ahead and submit a PR.
1419
4. A new feature should either have tests associated to it or state a very good reason for why not.

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
1-
[The end of dbdeployer](https://datacharmer.github.io/end-of-dbdeployer/)
2-
31
# dbdeployer
4-
[DBdeployer](https://github.com/datacharmer/dbdeployer) is a tool that deploys MySQL database servers easily.
2+
3+
[DBdeployer](https://github.com/ProxySQL/dbdeployer) is a tool that deploys MySQL database servers easily.
54
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.
65

6+
## New Maintainer
7+
8+
This project was originally created and maintained by [Giuseppe Maxia](https://github.com/datacharmer) (datacharmer). It is now actively maintained by the [ProxySQL](https://github.com/ProxySQL) team, continuing Giuseppe's excellent work while expanding the project's capabilities.
9+
10+
**Roadmap highlights:**
11+
12+
- ProxySQL and Orchestrator integration
13+
- Provider-based architecture for extensible database support
14+
- Eventual PostgreSQL support
15+
16+
See the [Phase 1 milestone](https://github.com/ProxySQL/dbdeployer/milestone/1) for current progress.
17+
718
Documentation updated for version 1.66.0 (26-Jul-2022 10:30 UTC)
819

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

1122
- [Installation](https://github.com/datacharmer/dbdeployer/wiki/installation)
1223
- [Manual installation](https://github.com/datacharmer/dbdeployer/wiki/installation#manual-installation)

0 commit comments

Comments
 (0)