-
Notifications
You must be signed in to change notification settings - Fork 22
Description
🚀 欢迎参加IvorySQL文档共建第一期(IvorySQL Docs Co-Build - First Edition)!
为了优化 IvorySQL文档,给大家带来更好的文档使用体验,IvorySQL文档共建计划第一期正式启动,将于2025年 9月 23日-12月 23日进行。同时,我们也希望借此机会激发社区活力,将 IvorySQL 社区成员聚集到一起,为大家带来一次有趣的协作体验。
在为期三个月的活动中,你将有机会与社区其他成员合作,共同改进 IvorySQL文档。
🗓️ 活动时间
在此次活动中,我们为大家准备了多个文档任务,包含撰写文档、优化文档、优化文档结构。
- 任务认领时间:即日起 — 12 月 23 日 16:00
- 任务提交时间:2025 年 9 月 23 日 至 2025 年 9 月 23 日 (北京时间)
参与方式
你可以在我们的 IvorySQL 文档共建第一期任务列表中查看所有可以领取的任务。
选择好感兴趣的任务后,你可以在任务对应的 issue 或 PR 的 comment 中添加 /assign 命令将此任务分配给自己。
如果一个 issue 或 PR 已经有 assignee,说明该任务已经有人认领,请重新选择其他的任务。
除了本次活动中列出的任务外,我们也非常欢迎你通过创建 issue 指出你发现的其他文档问题或创建 PR 来直接修复你发现的问题。
我们优化后的文档结构如下(目前只对外展示,未更新到官网文档):
https://www.kdocs.cn/l/cg7tqtbtTXYB
如果在活动期间,有参与者对文档结构提出了建议并被采纳,那么相应的就会以新的任务发布。
🎁活动奖品
IvorySQL 贡献者证书:
- 每位参与者将获得一个定制电子贡献者证书,你可以将它添加到你的 GitHub 个人主页 README 中彰显你为开源文档做出的贡献。
贡献者奖品:
- 凡是提交 issue,对文档结构或文档内容提出任何建议并最终被采纳的,可获得参与奖——IvorySQL 社区周边礼包:IvorySQL T 恤、IvorySQL 帆布袋、IvorySQL 冰箱贴、IvorySQL 眼罩。
另外,按照最终积分,设置以下奖励:
- 一等奖,奖品: beats 头戴式蓝牙耳机
- 二等奖,奖品:定制机械键盘
- 三等奖,奖品:3C 认证充电宝+一拖三数据线
另外,所有参与者还可获得书籍一本:
积分规则如下:
| 贡献方式 | 计分 | 备注 |
|---|---|---|
| 领取任务 | 1 | 每领取一个任务,获得 1 分 |
| 提交任务 PR | 5 | 每提交一个任务 PR,获得 5 分 |
| 任务 PR 被合并 | 10 | 每一个任务 PR 被合并,获得 10 分 |
| 提交 issue | 2 | 每提交一个 issue,获得 2 分 |
| issue 被采纳 | 4 | 每一个 issue 被采纳,获得 4 分 |
注:以上仅针对于本次活动中说明的对应方式,以上 PR 和 issue 提交都应在文档仓库下。
💡PR 快速上手指南
- Fork 文档仓库:
点击仓库右上角的 Fork 按钮,等待 Fork 完成即可。
IvorySQL文档:https://github.com/IvorySQL/ivorysql_docs - Clone 文档仓库,创建文档 PR:
- 参考任务列表中各 issue 的说明,提交 PR 或在 issue 上提供建议。
- 参考 asciidoc 语法快速参考 撰写文档或修改优化文档。
- 参考 IvorySQL 社区贡献指南 创建文档 PR。
- 在 PR 描述中,请注明此 PR 所相关的 issue。
- 关注并提交 PR 的修改建议:
- 创建 PR 后,我们会查看 PR 内容,并对需要修改的地方添加修改建议。
- 你可以接受建议并进行更改,或拒绝建议并在建议下方回复你的理由。
注:此活动相关的 PR,请提交到 master 分支下。
活动详情
• 关于此活动的更多信息,请参考 IvorySQL 文档共建第一期活动详情。
• 如有任何疑问或需要帮助,欢迎在此 issue 上添加评论。
Metadata
Metadata
Assignees
Labels
Type
Projects
Status