From 3144489f15eccea074e80cae1f176701720de54f Mon Sep 17 00:00:00 2001 From: inhere Date: Mon, 18 May 2020 20:19:02 +0800 Subject: [PATCH] update readme, add issue config file --- .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/annotation/README.md | 4 ++ src/annotation/README.zh-CN.md | 34 +++++++++++ src/aop/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/aop/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/aop/README.md | 4 ++ src/aop/README.zh-CN.md | 34 +++++++++++ src/bean/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/bean/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/bean/README.md | 4 ++ src/bean/README.zh-CN.md | 34 +++++++++++ src/config/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/config/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/config/README.md | 4 ++ src/config/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/connection-pool/README.md | 4 ++ src/connection-pool/README.zh-CN.md | 34 +++++++++++ src/console/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/console/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/console/README.md | 4 ++ src/console/README.zh-CN.md | 34 +++++++++++ src/db/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/db/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/db/README.md | 30 ++++++---- src/db/README.zh-CN.md | 34 +++++++++++ src/error/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/error/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/error/README.md | 4 ++ src/error/README.zh-CN.md | 34 +++++++++++ src/event/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/event/README.zh-CN.md | 6 +- .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/framework/README.md | 4 ++ src/framework/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/http-message/README.md | 4 ++ src/http-message/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/http-server/README.zh-CN.md | 6 +- src/i18n/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/i18n/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/i18n/README.md | 4 ++ src/i18n/README.zh-CN.md | 34 +++++++++++ src/log/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/log/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/log/README.md | 4 ++ src/log/README.zh-CN.md | 34 +++++++++++ src/process/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/process/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/process/README.md | 4 ++ src/process/README.zh-CN.md | 34 +++++++++++ src/proxy/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/proxy/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/proxy/README.md | 4 ++ src/proxy/README.zh-CN.md | 34 +++++++++++ src/redis/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/redis/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/redis/README.md | 4 ++ src/redis/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/rpc-client/README.md | 4 ++ src/rpc-client/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/rpc-server/README.zh-CN.md | 6 +- src/rpc/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/rpc/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/rpc/README.md | 4 ++ src/rpc/README.zh-CN.md | 34 +++++++++++ src/server/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/server/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/server/README.md | 4 ++ src/server/README.zh-CN.md | 34 +++++++++++ src/stdlib/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/stdlib/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/stdlib/README.md | 41 +++++++++---- src/stdlib/README.zh-CN.md | 34 +++++++++++ src/task/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/task/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/task/README.md | 4 ++ src/task/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/tcp-server/README.zh-CN.md | 6 +- src/tcp/.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/tcp/.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/tcp/README.md | 6 +- src/tcp/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ .../.github/PULL_REQUEST_TEMPLATE.md | 60 +++++++++++++++++++ src/validator/README.md | 4 ++ src/validator/README.zh-CN.md | 34 +++++++++++ .../.github/ISSUE_TEMPLATE/config.yml | 14 +++++ src/websocket-server/README.zh-CN.md | 6 +- 98 files changed, 2592 insertions(+), 37 deletions(-) create mode 100644 src/annotation/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/annotation/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/annotation/README.zh-CN.md create mode 100644 src/aop/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/aop/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/aop/README.zh-CN.md create mode 100644 src/bean/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/bean/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/bean/README.zh-CN.md create mode 100644 src/config/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/config/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/config/README.zh-CN.md create mode 100644 src/connection-pool/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/connection-pool/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/connection-pool/README.zh-CN.md create mode 100644 src/console/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/console/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/console/README.zh-CN.md create mode 100644 src/db/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/db/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/db/README.zh-CN.md create mode 100644 src/error/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/error/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/error/README.zh-CN.md create mode 100644 src/event/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/framework/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/framework/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/framework/README.zh-CN.md create mode 100644 src/http-message/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/http-message/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/http-message/README.zh-CN.md create mode 100644 src/http-server/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/i18n/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/i18n/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/i18n/README.zh-CN.md create mode 100644 src/log/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/log/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/log/README.zh-CN.md create mode 100644 src/process/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/process/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/process/README.zh-CN.md create mode 100644 src/proxy/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/proxy/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/proxy/README.zh-CN.md create mode 100644 src/redis/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/redis/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/redis/README.zh-CN.md create mode 100644 src/rpc-client/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/rpc-client/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/rpc-client/README.zh-CN.md create mode 100644 src/rpc-server/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/rpc/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/rpc/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/rpc/README.zh-CN.md create mode 100644 src/server/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/server/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/server/README.zh-CN.md create mode 100644 src/stdlib/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/stdlib/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/stdlib/README.zh-CN.md create mode 100644 src/task/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/task/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/task/README.zh-CN.md create mode 100644 src/tcp-server/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/tcp/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/tcp/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/tcp/README.zh-CN.md create mode 100644 src/validator/.github/ISSUE_TEMPLATE/config.yml create mode 100644 src/validator/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 src/validator/README.zh-CN.md create mode 100644 src/websocket-server/.github/ISSUE_TEMPLATE/config.yml diff --git a/src/annotation/.github/ISSUE_TEMPLATE/config.yml b/src/annotation/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/annotation/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/annotation/.github/PULL_REQUEST_TEMPLATE.md b/src/annotation/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/annotation/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/annotation/README.md b/src/annotation/README.md index 3d0d70c78..9858bb6b3 100644 --- a/src/annotation/README.md +++ b/src/annotation/README.md @@ -7,6 +7,10 @@ Swoft Annotation Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/annotation/README.zh-CN.md b/src/annotation/README.zh-CN.md new file mode 100644 index 000000000..b86521f1f --- /dev/null +++ b/src/annotation/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Annotation + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/annotation.svg)](https://packagist.org/packages/swoft/annotation) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Annotation Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/annotation +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/aop/.github/ISSUE_TEMPLATE/config.yml b/src/aop/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/aop/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/aop/.github/PULL_REQUEST_TEMPLATE.md b/src/aop/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/aop/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/aop/README.md b/src/aop/README.md index 118c81cf4..0fbb5d84e 100644 --- a/src/aop/README.md +++ b/src/aop/README.md @@ -7,6 +7,10 @@ Swoft Aop Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/aop/README.zh-CN.md b/src/aop/README.zh-CN.md new file mode 100644 index 000000000..9ebdf9b69 --- /dev/null +++ b/src/aop/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Aop + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/aop.svg)](https://packagist.org/packages/swoft/aop) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Aop Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/aop +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/bean/.github/ISSUE_TEMPLATE/config.yml b/src/bean/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/bean/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/bean/.github/PULL_REQUEST_TEMPLATE.md b/src/bean/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/bean/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/bean/README.md b/src/bean/README.md index 39043825c..22d4a61ef 100644 --- a/src/bean/README.md +++ b/src/bean/README.md @@ -7,6 +7,10 @@ Swoft Bean Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/bean/README.zh-CN.md b/src/bean/README.zh-CN.md new file mode 100644 index 000000000..d5e89f506 --- /dev/null +++ b/src/bean/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Bean + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/bean.svg)](https://packagist.org/packages/swoft/bean) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Bean Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/bean +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/config/.github/ISSUE_TEMPLATE/config.yml b/src/config/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/config/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/config/.github/PULL_REQUEST_TEMPLATE.md b/src/config/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/config/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/config/README.md b/src/config/README.md index 28059786c..64f6e5974 100644 --- a/src/config/README.md +++ b/src/config/README.md @@ -7,6 +7,10 @@ Swoft Config Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/config/README.zh-CN.md b/src/config/README.zh-CN.md new file mode 100644 index 000000000..bc14b39e4 --- /dev/null +++ b/src/config/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Config + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/config.svg)](https://packagist.org/packages/swoft/config) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Config Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/config +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/connection-pool/.github/ISSUE_TEMPLATE/config.yml b/src/connection-pool/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/connection-pool/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/connection-pool/.github/PULL_REQUEST_TEMPLATE.md b/src/connection-pool/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/connection-pool/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/connection-pool/README.md b/src/connection-pool/README.md index 513cafaa9..888b37182 100644 --- a/src/connection-pool/README.md +++ b/src/connection-pool/README.md @@ -7,6 +7,10 @@ Swoft Connection Pool Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/connection-pool/README.zh-CN.md b/src/connection-pool/README.zh-CN.md new file mode 100644 index 000000000..8d950b480 --- /dev/null +++ b/src/connection-pool/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Connection Pool + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/connection-pool.svg)](https://packagist.org/packages/swoft/connection-pool) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Connection Pool Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/connection-pool +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/console/.github/ISSUE_TEMPLATE/config.yml b/src/console/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/console/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/console/.github/PULL_REQUEST_TEMPLATE.md b/src/console/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/console/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/console/README.md b/src/console/README.md index f9371d960..7646ca29c 100644 --- a/src/console/README.md +++ b/src/console/README.md @@ -7,6 +7,10 @@ Swoft Console Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/console/README.zh-CN.md b/src/console/README.zh-CN.md new file mode 100644 index 000000000..d91d4ff80 --- /dev/null +++ b/src/console/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Console + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/console.svg)](https://packagist.org/packages/swoft/console) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Console Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/console +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/db/.github/ISSUE_TEMPLATE/config.yml b/src/db/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/db/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/db/.github/PULL_REQUEST_TEMPLATE.md b/src/db/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/db/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/db/README.md b/src/db/README.md index fd97f8d99..4088e7d4f 100644 --- a/src/db/README.md +++ b/src/db/README.md @@ -1,24 +1,34 @@ -# Swoft Database +# Swoft Db -Swoft Database Component +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/db.svg)](https://packagist.org/packages/swoft/db) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Db Component + +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) ## Install -Install by [Composer](https://getcomposer.org) +- composer command ```bash composer require swoft/db ``` -## Require - -- Swoole 2.1.2, enable coroutine, enable mysqld -- PDO Mysql +## Resources -## Document +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] -[Official document](https://swoft.org/docs) +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues ## LICENSE -Swoft Database Component is open-sourced software licensed under the [Apache license](LICENSE). +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/db/README.zh-CN.md b/src/db/README.zh-CN.md new file mode 100644 index 000000000..cffcd4294 --- /dev/null +++ b/src/db/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Db + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/db.svg)](https://packagist.org/packages/swoft/db) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Db Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/db +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/error/.github/ISSUE_TEMPLATE/config.yml b/src/error/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/error/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/error/.github/PULL_REQUEST_TEMPLATE.md b/src/error/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/error/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/error/README.md b/src/error/README.md index 13bb84fd8..584fb38e6 100644 --- a/src/error/README.md +++ b/src/error/README.md @@ -7,6 +7,10 @@ Swoft Error Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/error/README.zh-CN.md b/src/error/README.zh-CN.md new file mode 100644 index 000000000..64020ee6d --- /dev/null +++ b/src/error/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Error + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/error.svg)](https://packagist.org/packages/swoft/error) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Error Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/error +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/event/.github/ISSUE_TEMPLATE/config.yml b/src/event/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/event/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/event/README.zh-CN.md b/src/event/README.zh-CN.md index 6a9511d47..0f16f6ae6 100644 --- a/src/event/README.zh-CN.md +++ b/src/event/README.zh-CN.md @@ -11,15 +11,15 @@ Swoft Event Component English readme please sess [README.md](README.md) -## Install +## 安装 -- composer command +- composer 命令 ```bash composer require swoft/event ``` -## Resources +## 相关资源 * [Documentation](https://swoft.org/docs) * [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) diff --git a/src/framework/.github/ISSUE_TEMPLATE/config.yml b/src/framework/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/framework/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/framework/.github/PULL_REQUEST_TEMPLATE.md b/src/framework/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/framework/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/framework/README.md b/src/framework/README.md index b8f8cc094..3379b1450 100644 --- a/src/framework/README.md +++ b/src/framework/README.md @@ -7,6 +7,10 @@ Swoft Framework Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/framework/README.zh-CN.md b/src/framework/README.zh-CN.md new file mode 100644 index 000000000..aa467da1d --- /dev/null +++ b/src/framework/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Framework + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/framework.svg)](https://packagist.org/packages/swoft/framework) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Framework Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/framework +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/http-message/.github/ISSUE_TEMPLATE/config.yml b/src/http-message/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/http-message/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/http-message/.github/PULL_REQUEST_TEMPLATE.md b/src/http-message/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/http-message/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/http-message/README.md b/src/http-message/README.md index da59ac4b1..0f3dad2d8 100644 --- a/src/http-message/README.md +++ b/src/http-message/README.md @@ -7,6 +7,10 @@ Swoft Http Message Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/http-message/README.zh-CN.md b/src/http-message/README.zh-CN.md new file mode 100644 index 000000000..02706f829 --- /dev/null +++ b/src/http-message/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Http Message + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/http-message.svg)](https://packagist.org/packages/swoft/http-message) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Http Message Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/http-message +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/http-server/.github/ISSUE_TEMPLATE/config.yml b/src/http-server/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/http-server/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/http-server/README.zh-CN.md b/src/http-server/README.zh-CN.md index b699a1b74..7aa428283 100644 --- a/src/http-server/README.zh-CN.md +++ b/src/http-server/README.zh-CN.md @@ -11,15 +11,15 @@ Swoft Http Server Component English readme please sess [README.md](README.md) -## Install +## 安装 -- composer command +- composer 命令 ```bash composer require swoft/http-server ``` -## Resources +## 相关资源 * [Documentation](https://swoft.org/docs) * [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) diff --git a/src/i18n/.github/ISSUE_TEMPLATE/config.yml b/src/i18n/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/i18n/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/i18n/.github/PULL_REQUEST_TEMPLATE.md b/src/i18n/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/i18n/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/i18n/README.md b/src/i18n/README.md index 2ac743eb4..8beadc604 100644 --- a/src/i18n/README.md +++ b/src/i18n/README.md @@ -7,6 +7,10 @@ Swoft I18n Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/i18n/README.zh-CN.md b/src/i18n/README.zh-CN.md new file mode 100644 index 000000000..72dd07c21 --- /dev/null +++ b/src/i18n/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft I18n + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/i18n.svg)](https://packagist.org/packages/swoft/i18n) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft I18n Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/i18n +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/log/.github/ISSUE_TEMPLATE/config.yml b/src/log/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/log/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/log/.github/PULL_REQUEST_TEMPLATE.md b/src/log/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/log/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/log/README.md b/src/log/README.md index 6d94e4cd3..cd38d4e63 100644 --- a/src/log/README.md +++ b/src/log/README.md @@ -7,6 +7,10 @@ Swoft Log Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/log/README.zh-CN.md b/src/log/README.zh-CN.md new file mode 100644 index 000000000..2d247459f --- /dev/null +++ b/src/log/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Log + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/log.svg)](https://packagist.org/packages/swoft/log) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Log Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/log +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/process/.github/ISSUE_TEMPLATE/config.yml b/src/process/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/process/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/process/.github/PULL_REQUEST_TEMPLATE.md b/src/process/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/process/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/process/README.md b/src/process/README.md index 67b47b2b1..39d31586a 100644 --- a/src/process/README.md +++ b/src/process/README.md @@ -7,6 +7,10 @@ Swoft Process Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/process/README.zh-CN.md b/src/process/README.zh-CN.md new file mode 100644 index 000000000..585a26357 --- /dev/null +++ b/src/process/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Process + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/process.svg)](https://packagist.org/packages/swoft/process) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Process Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/process +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/proxy/.github/ISSUE_TEMPLATE/config.yml b/src/proxy/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/proxy/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/proxy/.github/PULL_REQUEST_TEMPLATE.md b/src/proxy/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/proxy/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/proxy/README.md b/src/proxy/README.md index 0b1abe9a4..5f3ce5e28 100644 --- a/src/proxy/README.md +++ b/src/proxy/README.md @@ -7,6 +7,10 @@ Swoft Proxy Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/proxy/README.zh-CN.md b/src/proxy/README.zh-CN.md new file mode 100644 index 000000000..9ee1e7736 --- /dev/null +++ b/src/proxy/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Proxy + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/proxy.svg)](https://packagist.org/packages/swoft/proxy) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Proxy Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/proxy +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/redis/.github/ISSUE_TEMPLATE/config.yml b/src/redis/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/redis/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/redis/.github/PULL_REQUEST_TEMPLATE.md b/src/redis/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/redis/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/redis/README.md b/src/redis/README.md index 5c6c0df25..fbe248e82 100644 --- a/src/redis/README.md +++ b/src/redis/README.md @@ -7,6 +7,10 @@ Swoft Redis Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/redis/README.zh-CN.md b/src/redis/README.zh-CN.md new file mode 100644 index 000000000..29f658564 --- /dev/null +++ b/src/redis/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Redis + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/redis.svg)](https://packagist.org/packages/swoft/redis) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Redis Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/redis +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/rpc-client/.github/ISSUE_TEMPLATE/config.yml b/src/rpc-client/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/rpc-client/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/rpc-client/.github/PULL_REQUEST_TEMPLATE.md b/src/rpc-client/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/rpc-client/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/rpc-client/README.md b/src/rpc-client/README.md index 25f651684..05d6fc5b2 100644 --- a/src/rpc-client/README.md +++ b/src/rpc-client/README.md @@ -7,6 +7,10 @@ Swoft Rpc Client Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/rpc-client/README.zh-CN.md b/src/rpc-client/README.zh-CN.md new file mode 100644 index 000000000..65c199dd5 --- /dev/null +++ b/src/rpc-client/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Rpc Client + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/rpc-client.svg)](https://packagist.org/packages/swoft/rpc-client) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Rpc Client Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/rpc-client +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/rpc-server/.github/ISSUE_TEMPLATE/config.yml b/src/rpc-server/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/rpc-server/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/rpc-server/README.zh-CN.md b/src/rpc-server/README.zh-CN.md index 09a96f184..cc4056936 100644 --- a/src/rpc-server/README.zh-CN.md +++ b/src/rpc-server/README.zh-CN.md @@ -11,15 +11,15 @@ Swoft Rpc Server Component English readme please sess [README.md](README.md) -## Install +## 安装 -- composer command +- composer 命令 ```bash composer require swoft/rpc-server ``` -## Resources +## 相关资源 * [Documentation](https://swoft.org/docs) * [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) diff --git a/src/rpc/.github/ISSUE_TEMPLATE/config.yml b/src/rpc/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/rpc/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/rpc/.github/PULL_REQUEST_TEMPLATE.md b/src/rpc/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/rpc/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/rpc/README.md b/src/rpc/README.md index 1bd879a73..4c6765636 100644 --- a/src/rpc/README.md +++ b/src/rpc/README.md @@ -7,6 +7,10 @@ Swoft Rpc Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/rpc/README.zh-CN.md b/src/rpc/README.zh-CN.md new file mode 100644 index 000000000..0a299d28e --- /dev/null +++ b/src/rpc/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Rpc + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/rpc.svg)](https://packagist.org/packages/swoft/rpc) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Rpc Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/rpc +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/server/.github/ISSUE_TEMPLATE/config.yml b/src/server/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/server/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/server/.github/PULL_REQUEST_TEMPLATE.md b/src/server/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/server/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/server/README.md b/src/server/README.md index 4896e052e..070c059f8 100644 --- a/src/server/README.md +++ b/src/server/README.md @@ -7,6 +7,10 @@ Swoft Server Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/server/README.zh-CN.md b/src/server/README.zh-CN.md new file mode 100644 index 000000000..f1d6799f0 --- /dev/null +++ b/src/server/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Server + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/server.svg)](https://packagist.org/packages/swoft/server) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Server Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/server +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/stdlib/.github/ISSUE_TEMPLATE/config.yml b/src/stdlib/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/stdlib/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/stdlib/.github/PULL_REQUEST_TEMPLATE.md b/src/stdlib/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/stdlib/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/stdlib/README.md b/src/stdlib/README.md index 420f8e88a..261aeb327 100644 --- a/src/stdlib/README.md +++ b/src/stdlib/README.md @@ -1,15 +1,34 @@ -# swoft stdlib +# Swoft Stdlib -Swoft tool and helper library. +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/stdlib.svg)](https://packagist.org/packages/swoft/stdlib) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) -- env -- php -- string -- array -- object -- json -- more ... +Swoft Stdlib Component -## License +## [中文说明](README.zh-CN.md) -[Apache 2.0](LICENSE) +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + +## Install + +- composer command + +```bash +composer require swoft/stdlib +``` + +## Resources + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/stdlib/README.zh-CN.md b/src/stdlib/README.zh-CN.md new file mode 100644 index 000000000..597e129ea --- /dev/null +++ b/src/stdlib/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Stdlib + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/stdlib.svg)](https://packagist.org/packages/swoft/stdlib) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Stdlib Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/stdlib +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/task/.github/ISSUE_TEMPLATE/config.yml b/src/task/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/task/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/task/.github/PULL_REQUEST_TEMPLATE.md b/src/task/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/task/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/task/README.md b/src/task/README.md index 95577ad12..be20d0176 100644 --- a/src/task/README.md +++ b/src/task/README.md @@ -7,6 +7,10 @@ Swoft Task Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/task/README.zh-CN.md b/src/task/README.zh-CN.md new file mode 100644 index 000000000..fdf824e35 --- /dev/null +++ b/src/task/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Task + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/task.svg)](https://packagist.org/packages/swoft/task) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Task Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/task +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/tcp-server/.github/ISSUE_TEMPLATE/config.yml b/src/tcp-server/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/tcp-server/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/tcp-server/README.zh-CN.md b/src/tcp-server/README.zh-CN.md index 38d38dc9b..c19ece586 100644 --- a/src/tcp-server/README.zh-CN.md +++ b/src/tcp-server/README.zh-CN.md @@ -11,15 +11,15 @@ Swoft Tcp Server Component English readme please sess [README.md](README.md) -## Install +## 安装 -- composer command +- composer 命令 ```bash composer require swoft/tcp-server ``` -## Resources +## 相关资源 * [Documentation](https://swoft.org/docs) * [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) diff --git a/src/tcp/.github/ISSUE_TEMPLATE/config.yml b/src/tcp/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/tcp/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/tcp/.github/PULL_REQUEST_TEMPLATE.md b/src/tcp/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/tcp/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/tcp/README.md b/src/tcp/README.md index 450ea7b14..c2d388f25 100644 --- a/src/tcp/README.md +++ b/src/tcp/README.md @@ -5,7 +5,11 @@ [![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) [![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) -Swoft Tcp Common Component +Swoft Tcp Component + +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) ## Install diff --git a/src/tcp/README.zh-CN.md b/src/tcp/README.zh-CN.md new file mode 100644 index 000000000..55b40b122 --- /dev/null +++ b/src/tcp/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Tcp + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/tcp.svg)](https://packagist.org/packages/swoft/tcp) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Tcp Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/tcp +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/validator/.github/ISSUE_TEMPLATE/config.yml b/src/validator/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/validator/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/validator/.github/PULL_REQUEST_TEMPLATE.md b/src/validator/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8b742aa30 --- /dev/null +++ b/src/validator/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +# PR + +- 请不要提交PR到各个组件仓库，它们都是 **只读的** +- 核心组件的 **开发仓库** 是 **[swoft/swoft-component][core]** +- 扩展组件的 **开发仓库** 是 **[swoft/swoft-ext][ext]** +- 请 `fork` 对应的 **开发仓库**，修改后，请把你的PR提交到对应的开发仓库 + +> 发布版本时官方会将代码同步到各个子仓库。因此，切记不要往子仓库发PR。 + +## 发起PR时的注意事项 + +开发组非常欢迎各位向我们提交PR(_Pull Request_)，但是为了保证代码质量和统一的风格， +向官方的主仓库 [swoft/swoft][main] 和 **开发仓库** 贡献代码时需要注意代码和commit格式 + +### Commit Message + +- commit message 只能是英文信息 +- 请尽量保证commit message是有意义的说明 +- 最好以 `add:` `update:` `fix:` 等关键字开头 + +### 代码风格 + +- 提交的PHP代码 **必须** 遵循 PSR-2 代码风格 +- 合理且有意义的类、方法、变量命名 +- 适当的注释，合理的使用空行保持代码的简洁，易于阅读 +- 不要包含一些无意义的信息 例如 `@author` 等(_提交者是能够从commit log里看到的_) + +------------------ + +> English Version (_translate by Google_) + +The development team welcomes you to submit PR (_Pull Request_) to us, but to ensure code quality and uniform style, +go to the official main repository [swoft/swoft][main] and Development repository, Note the code and commit format when contributing code + +## Precautions when initiating PR + +- Please do not submit PR to each sub-repository, they are all read-only +- The _development repository_ for the core components is **[swoft/swoft-component][core]** +- The _development repository_ for extension components is **[swoft/swoft-ext][ext]** +- Please `fork` the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse. + +> Officially syncs code to individual sub-warehouses when new versions are released + +### Commit Message + +- the commit message can only be in English +- Please try to ensure that the commit message is meaningful +- it is best to start with the keyword `add:` `update:` `fix:` + +### Code Style + +- Submitted PHP code **Must** Follow PSR-2 code style +- Reasonable and meaningful class, method, variable naming +- Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read +- Don't include some meaningless information such as `@author`, etc. (_author is that can be seen from the commit log_) + + +[main]: https://github.com/swoft-cloud/swoft +[core]: https://github.com/swoft-cloud/swoft-component +[ext]: https://github.com/swoft-cloud/swoft-ext diff --git a/src/validator/README.md b/src/validator/README.md index 68d30c781..9b7954fbb 100644 --- a/src/validator/README.md +++ b/src/validator/README.md @@ -7,6 +7,10 @@ Swoft Validator Component +## [中文说明](README.zh-CN.md) + +中文说明请查看 [README.zh-CN.md](README.zh-CN.md) + ## Install - composer command diff --git a/src/validator/README.zh-CN.md b/src/validator/README.zh-CN.md new file mode 100644 index 000000000..ae37a78a6 --- /dev/null +++ b/src/validator/README.zh-CN.md @@ -0,0 +1,34 @@ +# Swoft Validator + +[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/validator.svg)](https://packagist.org/packages/swoft/validator) +[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://secure.php.net/) +[![Swoft Doc](https://img.shields.io/badge/docs-passing-green.svg?maxAge=2592000)](https://www.swoft.org/docs) +[![Swoft License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) + +Swoft Validator Component + +## [ENGLISH](README.md) + +English readme please sess [README.md](README.md) + +## 安装 + +- composer 命令 + +```bash +composer require swoft/validator +``` + +## 相关资源 + +* [Documentation](https://swoft.org/docs) +* [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md) +* [Report Issues][issues] and [Send Pull Requests][pulls] in the [Main Swoft Repository][repository] + +[pulls]: https://github.com/swoft-cloud/swoft-component/pulls +[repository]: https://github.com/swoft-cloud/swoft +[issues]: https://github.com/swoft-cloud/swoft/issues + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/src/websocket-server/.github/ISSUE_TEMPLATE/config.yml b/src/websocket-server/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..26379859c --- /dev/null +++ b/src/websocket-server/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Swoft Issues + url: https://github.com/swoft-cloud/swoft/issues + about: Please report security vulnerabilities here. 请打开此页面报告bug或改进问题！ + - name: Swoft Development + url: https://github.com/swoft-cloud/swoft-component + about: Participate in contributing swoft code, please jump to this project. 参与贡献swoft代码，请跳转到这个项目 + - name: Swoft 中文文档 + url: https://swoft.org + about: Please ask and answer questions here. swoft 2.0新版风格中文文档。 + - name: Swoft English Documents + url: http://swoft.io + about: Please report security vulnerabilities here. swoft英文文档或者旧版风格文档请跳转此网站。 diff --git a/src/websocket-server/README.zh-CN.md b/src/websocket-server/README.zh-CN.md index cfbc38f6c..27c14d68f 100644 --- a/src/websocket-server/README.zh-CN.md +++ b/src/websocket-server/README.zh-CN.md @@ -11,15 +11,15 @@ Swoft Websocket Server Component English readme please sess [README.md](README.md) -## Install +## 安装 -- composer command +- composer 命令 ```bash composer require swoft/websocket-server ``` -## Resources +## 相关资源 * [Documentation](https://swoft.org/docs) * [Contributing](https://github.com/swoft-cloud/swoft/blob/master/CONTRIBUTING.md)