Skip to content

Commit

Permalink
update readme, add issue config file
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed May 18, 2020
1 parent 36cca20 commit 3144489
Show file tree
Hide file tree
Showing 98 changed files with 2,592 additions and 37 deletions.
14 changes: 14 additions & 0 deletions src/annotation/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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英文文档或者旧版风格文档请跳转此网站。
60 changes: 60 additions & 0 deletions src/annotation/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions src/annotation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

Swoft Annotation Component

## [中文说明](README.zh-CN.md)

中文说明请查看 [README.zh-CN.md](README.zh-CN.md)

## Install

- composer command
Expand Down
34 changes: 34 additions & 0 deletions src/annotation/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -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).
14 changes: 14 additions & 0 deletions src/aop/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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英文文档或者旧版风格文档请跳转此网站。
60 changes: 60 additions & 0 deletions src/aop/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions src/aop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

Swoft Aop Component

## [中文说明](README.zh-CN.md)

中文说明请查看 [README.zh-CN.md](README.zh-CN.md)

## Install

- composer command
Expand Down
34 changes: 34 additions & 0 deletions src/aop/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -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).
14 changes: 14 additions & 0 deletions src/bean/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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英文文档或者旧版风格文档请跳转此网站。
60 changes: 60 additions & 0 deletions src/bean/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions src/bean/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

Swoft Bean Component

## [中文说明](README.zh-CN.md)

中文说明请查看 [README.zh-CN.md](README.zh-CN.md)

## Install

- composer command
Expand Down
34 changes: 34 additions & 0 deletions src/bean/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -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).
14 changes: 14 additions & 0 deletions src/config/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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英文文档或者旧版风格文档请跳转此网站。
Loading

0 comments on commit 3144489

Please sign in to comment.