From 330387f73dc897c4c14e10906519ba5e981211f8 Mon Sep 17 00:00:00 2001 From: Him188 Date: Tue, 12 Jan 2021 16:22:22 +0800 Subject: [PATCH] Update docs --- CONTRIBUTING.md | 32 ++++++++++++++++++++++---------- README.md | 16 +++++++--------- 2 files changed, 29 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 615e614ea..954c9a9a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,23 +14,35 @@ mirai 欢迎一切形式的代码贡献。你可以通过以下几种途径向 m ### 分支 +- `1.x`: 1.x 版本的开发 (已停止) +- `dev`: 2.0 版本的开发 - `master`: 最新稳定版 -- `1.x`: 1.x 现有版本的开发 -- `dev`: 2.0 重构版本的开发 +- `-release` 后缀: 基于[版本规范](docs/Evolution.md#版本规范), 用于从 `dev` 中筛选 bugfix 并发布一个版本的 patch 的版本. 如 `2.0-release` 会包含 `2.0.x` 版本的更新. **请基于 `dev` 分支进行修改** ### 能做什么? -- 代码优化: 优化任何功能设计或实现, 或是引入一个新的设计（请先通过 issue 与维护者达成共识） -- 解决问题: 在 [issues](https://github.com/mamoe/mirai/issues) 查看 mirai 正遇到的所有问题, 或在 [里程碑](https://github.com/mamoe/mirai/milestones) 查看版本计划 -- 协议支持: 添加新协议支持 +- 维护社区: 可以为 [mirai-console](https://github.com/mamoe/mirai-console) 编写插件, 并发布到 discussions + +- 代码优化: 优化任何功能设计或实现, 或是引入一个新的设计（请先通过 issues 或 discussions 与维护者达成共识） +- 解决问题: 在 [issues](https://github.com/mamoe/mirai/issues) 查看 mirai 正遇到的所有问题, 或在 [里程碑](https://github.com/mamoe/mirai/milestones) 查看版本计划. 所有没有 assignee 的 issue 都处于 +- 协议支持: [添加新协议支持](#添加协议支持) + +### 里程碑 + +[里程碑](https://github.com/mamoe/mirai/milestones) 为各版本的开发计划. 在完成所有任务后就会发布该版本. + +`Backlog` 为没有设定目标版本的计划. 如果有相关 PR, 这些计划就可能会被确定到一个最近的版本. + +### 添加协议支持 + +请查看 [PacketFactory.kt](mirai-core/src/commonMain/kotlin/network/protocol/packet/PacketFactory.kt) 了解网络层架构. +参考现有的 `PacketFactory` 实现和一些有关协议的 PR (带有 `protocol` 标签) 了解如何添加新的 `PacketFactory`. + +> 如果你不熟悉 Kotlin 或不熟练 Kotlin 也没关系, 你的 PR 会首先被维护者审阅并会收到修改建议. mirai 感谢你的每一行代码并会尽可能帮助你. + ### 注意事项 - 尽量不要引用新的库 - 遵守 Kotlin 官方代码规范（提交前使用 IDE 格式化代码 (commit 时勾选 'Reformat code')） - -## 社区 - -插件社区不要求太高的代码质量，任何人都可以帮助 mirai。 -可以为 [mirai-console](https://github.com/mamoe/mirai-console) 编写插件, 并发布到 Discussions diff --git a/README.md b/README.md index ac03935cf..db3848fec 100644 --- a/README.md +++ b/README.md @@ -120,27 +120,25 @@ mirai 是一个在全平台下运行，提供 QQ Android 协议支持的高效 ## 开始 -- 开发文档：[docs](docs/README.md) +- 开发文档: [docs](docs/README.md) - 更新日志: [release](https://github.com/mamoe/mirai/releases) - 开发计划: [milestones](https://github.com/mamoe/mirai/milestones) +- 讨论: [GitHub Discussions](https://github.com/mamoe/mirai/discussions) 和 [![Gitter](https://badges.gitter.im/mamoe/mirai.svg)](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + > 在 GitHub Discussions 提出的问题可能会收到 mirai 维护者的回复, 也欢迎分享你基于 mirai 的项目或想法. -- 贡献: [CONTRIBUTING](CONTRIBUTING.md) +- mirai 官方系列项目: [project-mirai](https://github.com/project-mirai) +- mirai 社区相关项目: [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md) **** -- [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md) **mirai相关项目合集** +- 帮助 mirai: [CONTRIBUTING](CONTRIBUTING.md) ## [贡献](CONTRIBUTING.md) -我们欢迎一切形式的贡献。 -我们也期待有更多人能加入 mirai 的开发。 - -若在使用过程中有任何疑问，可提交 [`issue`](https://github.com/mamoe/mirai/issues) 或在 [`Discussions`](https://github.com/mamoe/mirai/discussions) 讨论。 我们希望 mirai 变得更易用. - 您的 `star` 是对我们最大的鼓励(点击项目右上角) 开发交流：[![Gitter](https://badges.gitter.im/mamoe/mirai.svg)](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ### 加入 mirai 开发组 -若您有意加入 mirai, mirai-console 和相关社区开发, 请 [邮件联系](mailto:support@mamoe.net) (`support@mamoe.net`), 并附加相关开发经验证明. +若您有意加入 mirai, mirai-console 和相关社区开发, 请 [邮件联系](mailto:support@mamoe.net) (`support@mamoe.net`), 并附加你的个人主页如 GitHub. ## 鸣谢