This is an automated email from the ASF dual-hosted git repository. duanzhengqiang pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/shardingsphere-plugin.git
commit 56b27d7a7e28b823af307fed05a8729afc755274 Author: duanzhengqiang <[email protected]> AuthorDate: Wed Sep 27 18:28:22 2023 +0800 Update readme doc --- README.md | 4 ++-- README_ZH.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bded266..3fa1c71 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # OVERVIEW -ShardingSphere Plugin is designed to provide a plug-in implementation for ShardingSphere pluggable architecture. You can refer to [ShardingSphere dev manual](https://shardingsphere.apache.org/document/current/en/dev-manual/) to extend the SPI. +ShardingSphere Plugin is designed to provide a plug-in implementation for ShardingSphere pluggable architecture. You can refer to ShardingSphere [Dev Manual](https://shardingsphere.apache.org/document/current/en/dev-manual/) to extend the SPI. Developers are welcome to contribute to the implementation of plug-ins and build a distributed database ecosystem of ShardingSphere. [](https://github.com/apache/shardingsphere-plugin/blob/main/README.md) @@ -32,7 +32,7 @@ These plugins can be found in [ShardingSphere Plugins](https://github.com/apache When using ShardingSphere-JDBC, users only need to add maven dependencies to the project to complete the plug-in installation. When using ShardingSphere-Proxy, they need to download the plug-in jar package and the jar packages that the plug-in may depend on, and then copy them to ShardingSphere-Proxy `ext-lib` directory. When developers contribute new plug-ins, they need to refer to [Contributor Guide](https://shardingsphere.apache.org/community/en/involved/contribute/contributor/) and first execute `./mvnw clean install -DskipITs -DskipTests -Prelease` to package ShardingSphere basic SPI and test components, and then create a new module for plug-in development. -Newly developed plug-in code needs to follow [ShardingSphere development specifications](https://shardingsphere.apache.org/community/en/involved/conduct/code/). +Newly developed plug-in code needs to follow ShardingSphere [Code of Conduct](https://shardingsphere.apache.org/community/en/involved/conduct/code/). # Plug-in Implementation diff --git a/README_ZH.md b/README_ZH.md index ce54cf8..85e47dc 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -20,7 +20,7 @@ # 概述 -ShardingSphere Plugin 旨在为 ShardingSphere 可插拔架构提供插件实现，可以参考 [ShardingSphere 开发者手册](https://shardingsphere.apache.org/document/current/cn/dev-manual/) 对 SPI 进行扩展。 +ShardingSphere Plugin 旨在为 ShardingSphere 可插拔架构提供插件实现，可以参考 ShardingSphere [开发者手册](https://shardingsphere.apache.org/document/current/cn/dev-manual/)对 SPI 进行扩展。 欢迎广大开发者们积极贡献插件实现，一起打造 ShardingSphere 分布式的数据库生态系统。 [](https://github.com/apache/shardingsphere-plugin/blob/main/README.md) @@ -31,8 +31,8 @@ ShardingSphere Plugin 旨在为 ShardingSphere 可插拔架构提供插件实现 ShardingSphere Plugin 仓库中的插件会和 ShardingSphere 保持相同的发布节奏，可以在 https://central.sonatype.com/ 进行检索，并安装到 ShardingSphere 中。 用户使用 ShardingSphere-JDBC 时，只需要将 maven 依赖添加到项目中即可完成插件安装，使用 ShardingSphere-Proxy 时，需要下载插件 jar 包及插件可能依赖的 jar 包，然后拷贝到 ShardingSphere-Proxy 的 `ext-lib` 目录下。 -开发者贡献新的插件时，需要参考 [贡献者指南](https://shardingsphere.apache.org/community/cn/involved/contribute/contributor/)，先执行 `./mvnw clean install -DskipITs -DskipTests -Prelease` 打包 ShardingSphere 基础 SPI 及测试组件，然后再新建模块进行插件开发。 -新开发的插件代码需要遵循 [ShardingSphere 开发规范](https://shardingsphere.apache.org/community/cn/involved/conduct/code/)。 +开发者贡献新的插件时，需要参考[贡献者指南](https://shardingsphere.apache.org/community/cn/involved/contribute/contributor/)，先执行 `./mvnw clean install -DskipITs -DskipTests -Prelease` 打包 ShardingSphere 基础 SPI 及测试组件，然后再新建模块进行插件开发。 +新开发的插件代码需要遵循 ShardingSphere [开发规范](https://shardingsphere.apache.org/community/cn/involved/conduct/code/)。 # 插件实现
