文档是开源项目的重要组成部分。结构清晰、内容详细且准确、易于理解,这样的文档可以让用户更容易理解并上手使用开源项目,在使用的过程中,大部分问题也可以通过阅读理解文档来解决。在开源数据库的世界里,一份完整、准确的文档不仅是技术的指南针,更是社区成长的基石。
作为一款基于 PostgreSQL 的开源数据库,IvorySQL 一直致力于提供更优质的用户体验。然而,随着功能的不断迭代和任务的增多,IvorySQL 文档还有待进一步完善。为了让文档更全面、更易用,同时激发社区活力,我们决定将文档更新任务开放给整个社区,并通过丰厚的奖励激励大家参与!
IvorySQL 文档共建计划第一期现已正式开启!这一期活动为期 3 个月,重点聚焦新增文档内容。我们诚挚邀请您加入,一起优化文档结构、补充缺失目录,并通过实际贡献赢得奖励。未来,我们还将不定期开展后续期活动,让共建成为 IvorySQL 社区的常态。
活动时间
- 活动开始时间:2025 年 9 月 23 日
- 活动结束时间:2025 年 12 月 23 日
活动任务
- 撰写新文档(包括中英文两版),提交 PR
- 对现有文档结构提出建议,如需要新增哪些文档,文档目录调整等等(issue)
- 对现有文档可进行验证和检查,如有错误可提交修改建议(issue)或直接修改(PR)
活动参与方式
- 方式一:提 PR 完成任务列表中的任务 (推荐)
- 在活动任务列表中,选择感兴趣的任务并点开该任务。
- 在任务的 issue 或者 pull request (PR) 上,通过在 comment 中添加 /assign 命令认领任务。
- 提交 PR 解决任务,在 PR 描述中提供 PR 相关的 issue 链接,在 PR comment 中通过添加 /label ivorysql-docs-build 命令标识 PR,并处理 PR 收到的评审建议。
- 方式二:提 issue 指出文档问题,包含但不限于文档目录结构以及文档内容的准确性、完整性、清晰性等问题。
- 方式三:提 PR 解决任何文档问题。
- 方式四:为活动任务列表中的 issue 提供有价值的评论。
我们优化后的文档结构如下(未更新到官网文档):https://www.kdocs.cn/l/cg7tqtbtTXYB
注:此活动相关的 PR,请提交到master分支下。
活动奖励
凡是参与了本次活动,提交的意见被采纳,提交的 PR 被合并,即视为做出了贡献,即可获得 IvorySQL 贡献者证书。
此外还有好礼相送。
参与奖:凡是提交 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 提交都应在文档仓库下。
FAQ
- 参与本活动需要什么条件?
需要有 GitHub 账号,在提交 PR 前阅读 IvorySQL 贡献流程指南,并签署贡献者许可协议(CLA)。为了大家更流畅的撰写文档,请阅读文档语法参考。
- IvorySQL 项目的 GitHub 仓库和文档仓库地址是什么?
- IvorySQL:https://github.com/IvorySQL/IvorySQL
- IvorySQL 文档:https://github.com/IvorySQL/ivorysql_docs
- 提交的 issue 和 PR 一定会被采纳吗?
贡献者提交 issue 后,我们会进行审核,如符合需求,会被采纳。
贡献者提交 PR 后,同样会进行审核,并反馈修改建议,因此一个新的文档可能会进行多次修改,直到符合合并条件。
- 参与活动期间,有问题如何获得帮助?
您可以加入本次活动的专属交流微信群,在群内进行交流。
进群方式:添加微信小助理 IvorySQL_official,备注参加文档活动第一期。或直接扫描下方二维码进群。