当前位置：网站首页>StoneDB 文档捉虫活动第一季

StoneDB 文档捉虫活动第一季

2022-08-10 10:59:00 【InfoQ】

各位社区的小伙伴们，StoneDB 第一季文档捉虫活动带着周边上线啦！！！

6月29日 StoneDB 举办了线上发布会，正式宣布开源。虽然开源前做足了准备，bug 还是在所难免。在这一个多月里我们收到了太多因为文档问题而产生的各类报错反馈，在为社区用户解答提问的同时，我们也在第一时间检查了相关的文档内容并做出修正。考虑到这一次的修正未必能百分百的解决所有文档上的痛点，为了找出这些潜在的漏洞，我们决定举办这次的文档捉虫活动。正所谓人多力量大，为了给所有的社区用户一个更好的使用感受，我们诚挚地邀请社区的伙伴们运用火眼金睛，一起完善社区文档！共建属于大家的开源社区！

参与 StoneDB 文档捉虫活动，提交有效 issue 或者 PR 获得对应积分，即可兑换社区的精美周边礼品，同时跟技术大佬们一起出现在社区官网贡献者页面，让我们期待您的参与！

一、活动报名


添加 StoneDB 小助手（ StoneDB_2022 ）为微信好友，发送您的“ GitHub 用户名+报名文档捉虫活动”并关注公众号，即报名成功。

活动时间：8月9日至9月12日

二、参与活动

1.提 issue
请先阅读 StoneDB 的文档，发现文档中存在的错误，前往 StoneDB 的 文档仓库提 issue，提交前请先搜索该问题是否已有记录。

2.提 PR
请确定需要解决的文档问题，需要有对应的 issue 。Fork StoneDB仓库并修改问题 ，然后提交 PR。除了自己提交的 issue ，其他尚未得到解决的 issue 也可认领并提交 PR 哦~

3.文档仓库地址
中文文档位置：https://github.com/stoneatom/stonedb/tree/stonedb-5.7/website/i18n/zh/docusaurus-plugin-content-docs/current
英文文档位置：https://github.com/stoneatom/stonedb/tree/stonedb-5.7/Docs
注：本次文档捉虫限5.7版本。

三、积分规则


1.低错类问题：
每个 issue 1 分、每个 PR 2 分。
● 错别字、拼写错误、链接错误异常、文档格式错乱等
● 表述不通顺，但不影响理解

2.易用性问题：
每个 issue 3 分、每个 PR 5 分。
● 关键步骤错误或缺失，无法指导用户完成任务
● 缺少必要的前提条件、注意事项等
● 文档内代码错误，例如少空格、少引号等

3.正确性问题：
每个 issue 5 分、每个 PR 8 分。
● 描述存在歧义，逻辑不清晰
● 原理图、架构图、功能等存在错误
● 关键参数描述错误，无法指导用户完成任务

4.风险提示类问题：
每个 issue 8 分、每个 PR 12 分。
● 对重要数据或系统存在特别风险的操作，缺少安全提示

四、奖品兑换


  • 徽章=5个积分；POLO衫=10个积分；自动伞=15积分；双肩包=20个积分（如有剩余积分，可重复兑换）；
  • 中国地区外的参赛选手，由于受物流限制，无法获得实物奖品。但 StoneDB 社区为您进行准备了荣誉证书以及感谢信，将通过邮件的形式发送给您，同时您也会在官网以贡献者的身份露出。
  • 如果您的 issue 或 pr 为有效，即可获得对应的积分，积分榜将在每天晚上6点在 StoneDB GitHub discussions 公示，同时同步至社群和 Slack 。获奖名单也会在活动结束后更新至 StoneDB GitHub discussions 。请关注社区资讯。
  • 所有奖品在活动结束后统一发放，StoneDB 小助手将会在活动结束后三天内联系您，活动期间您可以在 StoneDB 微信社群、slack 或 GitHub discussions 参与讨论，追踪活动进度。

PS：部分文档中尚未有内容，我们诚意邀请社区的小伙伴一起内容共建，贡献整篇文档可获得社区整套周边（徽章+POLO衫+雨伞+背包）


null

五、规则说明


  • 一个 issue 或 pr 仅提交一个问题，多个问题请不要在一次性提交。
  • 同样的问题在不同文档出现，如果多次提交，只算一个问题。
  • 同一问题多人反馈，按时间排序靠前者为准。
  • 每个 issue 或 PR 请贴上对应问题类型的标签（如低错类=P01，易用性=P02，正确性=P03，风险提示类=P04），以方便我们验证和统计您的积分。
  • GitHub 上的所有提交和讨论请使用英文，中文 issue 或 PR 将视为无效，工作人员会提醒您用英文重新提交。
  • 以下问题视为无效：
● 问题无法定位
● 问题无法复现
● 问题非首次反馈
● 其他经社区审核判定无效的情况

六、其他推荐


社区官网：https://stonedb.io/
代码仓库：https://github.com/stoneatom/stonedb
原网站

版权声明
本文为[InfoQ]所创，转载请带上原文链接，感谢
https://xie.infoq.cn/article/2fb694fd95999898a3404a812

边栏推荐

猜你喜欢

随机推荐