mirror of
https://gitee.com/hyperf/hyperf.git
synced 2024-11-30 02:37:58 +08:00
Add versions and contribute
This commit is contained in:
huangzhhui
parent
3ca22c6124
commit
606b4adbb6
19
doc/zh-cn/contribute.md
Normal file
19
doc/zh-cn/contribute.md
Normal file
@ -0,0 +1,19 @@
|
||||
# 参与开发
|
||||
|
||||
Hyperf 是一个开源项目，一个开源项目的发展离不开开源社区的力量支持，如果您希望参与 Hyperf 的开发，可以先从 [issues](https://github.com/hyperf/hyperf/issues?page=2&q=is%3Aissue+is%3Aopen) 开始，通常来说会有以下的一些步骤：
|
||||
|
||||
1. 关注 [issues](https://github.com/hyperf/hyperf/issues?page=2&q=is%3Aissue+is%3Aopen) 的动态，评论回复帮助提出疑问的用户；
|
||||
2. 根据 [issues](https://github.com/hyperf/hyperf/issues?page=2&q=is%3Aissue+is%3Aopen) 的内容，找寻根据自己当前对 Hyperf 的了解程度，去修复力所能及的 BUG 或实现功能，并以 [Pull Request](https://https://github.com/hyperf/pulls) 的形式提交至 [hyperf/hyperf](https://github.com/hyperf/hyperf) 仓库；
|
||||
3. 关注自己提交 Pull Request 的进度和状态，以推动您的 Pull Request 尽快合入主仓库；
|
||||
4. 对其他人提交的 Pull Request 进行 Code Review，并给出您的建议和看法。
|
||||
5. 根据他人或自己的需求，研发独立的功能组件；
|
||||
6. 坚持并持续进行上述步骤。
|
||||
|
||||
## 加入 Hyperf 团队
|
||||
|
||||
Hyperf 团队是对 Hyperf 项目及其周边项目进行持续维护和迭代的团队，如果您希望加入其中，首先需要您对 Hyperf 拥有足够且持续的热情，因为需要您付出大量的时间和精力到 Hyperf 项目及其周边项目的维护和迭代工作上，同时也需要您对 Hyperf 项目有足够的深入了解，以便维护工作的进行。因此我们对加入 Hyperf 团队也设有一定的门槛，您需要在 [hyperf/hyperf](https://github.com/hyperf/hyperf) 仓库拥有最少 100 commits，或向 Hyperf 提交了多个优秀的组件，同时由任一现有的 Hyperf 团队成员提名，并获得团队内超半数成员的同意。
|
||||
|
||||
加入到 Hyperf 团队，您会得到包括但不限于以下的收获：
|
||||
1. @hyperf.io E-mail
|
||||
2. [Jetbrains All Products Pack](https://www.jetbrains.com/store/#commercial?billing=yearly) (US $649/year)
|
||||
3. [Github team membership](https://github.com/orgs/hyperf/people)
|
||||
13
doc/zh-cn/release-planning.md
Normal file
13
doc/zh-cn/release-planning.md
Normal file
@ -0,0 +1,13 @@
|
||||
# 版本计划
|
||||
|
||||
## 版本生命周期
|
||||
|
||||
| 版本 | 状态 | 积极支持截止时间 | 安全维护截止时间 | 发布或预计发布时间 |
|
||||
| ---- | -------- | ---------------- | ---------------- | ------------------ |
|
||||
| 2.0 | 研发中 | / | / | 2020-06-23 |
|
||||
| 1.1 | 维护中 | 2020-06-23 | 2020-12-31 | |
|
||||
| 1.0 | 停止维护 | 2019-10-08 | 2019-12-31 | 2019-06-20 |
|
||||
|
||||
## 版本迭代周期
|
||||
|
||||
Hyperf 采用敏捷开发模式，每周一个迭代计划，并于 `每周的星期四 (UTC/GMT+08:00)` 发布一个版本，通常来说是一个 z 版本的发布。关于 Hyperf 采用的版本规则，请查阅 [版本说明](zh/versions.md) 一章。
|
||||
@ -3,6 +3,12 @@
|
||||
* [项目介绍](zh-cn/README.md)
|
||||
* [线上交流](zh-cn/communication.md)
|
||||
* [捐献及赞助](zh-cn/donate.md)
|
||||
* [参与开发](zh-cn/contribute.md)
|
||||
|
||||
* 版本管理
|
||||
|
||||
* [版本计划](zh-cn/release-planning.md)
|
||||
* [版本说明](zh-cn/versions.md)
|
||||
* [版本更新记录](zh-cn/changelog.md)
|
||||
|
||||
* 快速入门
|
||||
|
||||
12
doc/zh-cn/versions.md
Normal file
12
doc/zh-cn/versions.md
Normal file
@ -0,0 +1,12 @@
|
||||
# 版本说明
|
||||
|
||||
## 版本规则
|
||||
|
||||
Hyperf 采用 x.y.z 的版本号规则来命名各个版本，如 1.2.3 版本，1 即为 x，2 即为 y，3 即为 z，您可以根据该版本规则来制定您对 Hyperf 框架的更新计划。
|
||||
- x 表示一个重大版本，当 Hyperf 的核心进行大量的重构变动时，或当存在大量的破坏性 API 变更时，会作为一个 x 版本发布，x 版本变更通常来说是无法与之前的 x 版本兼容，但也不一定代表完全无法兼容，具体根据对应版本的升级指南来进行甄别。
|
||||
- y 表示一个主要功能迭代版本，当一些公开的 API 进行了破坏性的变更后，包括公开 API 的变更和删除，导致前置版本可能无法兼容的时候，会以 y 版本来进行发布。
|
||||
- z 表示一个完全兼容的修复版本，当对各个组件的已有功能进行 BUG 修复或安全修复时，会选择以一个 z 版本来发布，当一个 BUG 导致了某个功能完全无法使用时，亦可能在 z 版本内修复这个 BUG 时对 API 进行破坏性变更，但由于功能此前已经完全无法使用故此类变更不会以 y 版本来发布，除了 BUG 修复，z 版本也可能会包括一些新增的功能或组件，这些功能和组件均不会影响此前的代码使用。
|
||||
|
||||
## 升级版本
|
||||
|
||||
当您希望升级 Hyperf 版本时，如果是对 x 和 y 版本的升级，请根据文档内对应版本的升级指南来进行操作。如您希望对 z 版本进行升级，可直接在您的项目的根目录执行 `composer update hyperf` 命令来对依赖包进行更新，我们不建议您单独升级某一个组件的版本，而是统一升级所有组件来获得更加一致的体验。
|
||||
125
docs/zh-cn/summary.md
Normal file
125
docs/zh-cn/summary.md
Normal file
@ -0,0 +1,125 @@
|
||||
* 前言
|
||||
|
||||
* [项目介绍](zh-cn/README.md)
|
||||
* [线上交流](zh-cn/communication.md)
|
||||
* [捐献及赞助](zh-cn/donate.md)
|
||||
* [参与开发](zh/contribute.md)
|
||||
|
||||
* 版本管理
|
||||
* [版本计划](zh-cn/release-planning.md)
|
||||
* [版本说明](zh-cn/versions.md)
|
||||
* [版本更新记录](zh-cn/changelog.md)
|
||||
|
||||
* 快速入门
|
||||
|
||||
* [安装](zh-cn/quick-start/install.md)
|
||||
* [快速开始](zh-cn/quick-start/overview.md)
|
||||
* [常见问题](zh-cn/quick-start/questions.md)
|
||||
* [编程须知](zh-cn/quick-start/important.md)
|
||||
|
||||
* 核心架构
|
||||
|
||||
* [生命周期](zh-cn/lifecycle.md)
|
||||
* [协程](zh-cn/coroutine.md)
|
||||
* [配置](zh-cn/config.md)
|
||||
* [注解](zh-cn/annotation.md)
|
||||
* [依赖注入](zh-cn/di.md)
|
||||
* [事件机制](zh-cn/event.md)
|
||||
* [AOP 面向切面编程](zh-cn/aop.md)
|
||||
|
||||
* 基础功能
|
||||
|
||||
* [路由](zh-cn/router.md)
|
||||
* [中间件](zh-cn/middleware/middleware.md)
|
||||
* [控制器](zh-cn/controller.md)
|
||||
* [请求](zh-cn/request.md)
|
||||
* [响应](zh-cn/response.md)
|
||||
* [异常处理](zh-cn/exception-handler.md)
|
||||
* [缓存](zh-cn/cache.md)
|
||||
* [日志](zh-cn/logger.md)
|
||||
* [分页器](zh-cn/paginator.md)
|
||||
* [命令行](zh-cn/command.md)
|
||||
* [自动化测试](zh-cn/testing.md)
|
||||
* [视图](zh-cn/view.md)
|
||||
* [国际化](zh-cn/translation.md)
|
||||
* [验证器](zh-cn/validation.md)
|
||||
* [Session 会话管理](zh-cn/session.md)
|
||||
* [文件系统](zh-cn/filesystem.md)
|
||||
|
||||
* 数据库模型
|
||||
|
||||
* [快速开始](zh-cn/db/quick-start.md)
|
||||
* [查询构造器](zh-cn/db/querybuilder.md)
|
||||
* [模型](zh-cn/db/model.md)
|
||||
* [模型关系](zh-cn/db/relationship.md)
|
||||
* [查询分页](zh-cn/db/paginator.md)
|
||||
* [模型事件](zh-cn/db/event.md)
|
||||
* [模型缓存](zh-cn/db/model-cache.md)
|
||||
* [数据库迁移](zh-cn/db/migration.md)
|
||||
* [极简 DB 组件](zh-cn/db/db.md)
|
||||
* [修改器](zh-cn/db/mutators.md)
|
||||
|
||||
* 微服务
|
||||
|
||||
* [架构理念](zh-cn/microservice.md)
|
||||
* [JSON RPC 服务](zh-cn/json-rpc.md)
|
||||
* [gRPC 服务](zh-cn/grpc.md)
|
||||
* [服务注册](zh-cn/service-register.md)
|
||||
* [服务熔断及降级](zh-cn/circuit-breaker.md)
|
||||
* [服务限流](zh-cn/rate-limit.md)
|
||||
* [配置中心](zh-cn/config-center.md)
|
||||
* [调用链追踪](zh-cn/tracer.md)
|
||||
* [服务监控](zh-cn/metric.md)
|
||||
* [服务重试](zh-cn/retry.md)
|
||||
|
||||
* 消息队列
|
||||
|
||||
* [Redis 异步队列](zh-cn/async-queue.md)
|
||||
* [AMQP](zh-cn/amqp.md)
|
||||
* [Nats](zh-cn/nats.md)
|
||||
* [Nsq](zh-cn/nsq.md)
|
||||
|
||||
* 其它组件
|
||||
|
||||
* [连接池](zh-cn/pool.md)
|
||||
* [Redis 协程客户端](zh-cn/redis.md)
|
||||
* [Guzzle HTTP 协程客户端](zh-cn/guzzle.md)
|
||||
* [Elasticsearch 协程客户端](zh-cn/elasticsearch.md)
|
||||
* [Consul 协程客户端](zh-cn/consul.md)
|
||||
* [ETCD 协程客户端](zh-cn/etcd.md)
|
||||
* [WebSocket 服务](zh-cn/websocket-server.md)
|
||||
* [WebSocket 协程客户端](zh-cn/websocket-client.md)
|
||||
* [Socket.io 服务](zh-cn/socketio-server.md)
|
||||
* [自定义进程](zh-cn/process.md)
|
||||
* [开发者工具](zh-cn/devtool.md)
|
||||
* [辅助类](zh-cn/utils.md)
|
||||
* [限流器](zh-cn/rate-limit.md)
|
||||
* [Swoole Tracker](zh-cn/swoole-tracker.md)
|
||||
* [定时任务](zh-cn/crontab.md)
|
||||
* [Task 机制](zh-cn/task.md)
|
||||
* [枚举类](zh-cn/constants.md)
|
||||
* [Snowflake](zh-cn/snowflake.md)
|
||||
* [重试](zh-cn/retry.md)
|
||||
* [信号处理器](zh-cn/signal.md)
|
||||
|
||||
* 应用部署
|
||||
|
||||
* [Docker Swarm 集群搭建](zh-cn/tutorial/docker-swarm.md)
|
||||
* [DaoCloud Devops 搭建](zh-cn/tutorial/daocloud.md)
|
||||
* [Supervisor 部署](zh-cn/tutorial/supervisor.md)
|
||||
* [Nginx 反向代理](zh-cn/tutorial/nginx.md)
|
||||
* [阿里云日志服务](zh-cn/tutorial/aliyun-logger.md)
|
||||
|
||||
* Awesome Hyperf
|
||||
|
||||
* [协程组件库](zh-cn/awesome-components.md)
|
||||
|
||||
* 组件开发指南
|
||||
|
||||
* [指南前言](zh-cn/component-guide/intro.md)
|
||||
* [创建新的组件](zh-cn/component-guide/create.md)
|
||||
* [ConfigProvider 机制](zh-cn/component-guide/configprovider.md)
|
||||
|
||||
* 版本升级指南
|
||||
|
||||
* [1.1 升级指南](zh-cn/upgrade/1.1.md)
|
||||
Loading…
Reference in New Issue
Block a user