关于mysql:StoneDB-文档捉虫活动第一季

56次阅读

共计 1764 个字符,预计需要花费 5 分钟才能阅读完成。

各位社区的小伙伴们,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/…
英文文档地位:https://github.com/stoneatom/…
注:本次文档捉虫限 5.7 版本。

三、积分规定

1. 低错类问题:每个 issue 1 分、每个 PR 2 分。
错别字、拼写错误、链接谬误异样、文档格局错乱等表述不通顺,但不影响了解

2. 易用性问题 :每个 issue 3 分、每个 PR 5 分。
关键步骤谬误或缺失,无奈领导用户实现工作短少必要的前提条件、注意事项等
文档内代码谬误,例如少空格、少引号等

3. 正确性问题:每个 issue 5 分、每个 PR 8 分。
形容存在歧义,逻辑不清晰
原理图、架构图、性能等存在谬误
要害参数形容谬误,无奈领导用户实现工作

4. 危险提醒类问题:每个 issue 8 分、每个 PR 12 分。
对重要数据或零碎存在特地危险的操作,短少平安提醒

四、奖品兑换

1. 徽章 = 5 个积分;POLO 衫 =10 个积分;自动伞 =15 积分;双肩包 =20 个积分(如有残余积分,可反复兑换);

2. 中国地区外的参赛选手,因为受物流限度,无奈取得实物奖品。但 StoneDB 社区为您进行筹备了荣誉证书以及感谢信,将通过邮件的模式发送给您,同时您也会在官网以贡献者的身份露出。

3. 如果您的 issue 或 pr 为无效,即可取得对应的积分,积分榜将在每天晚上 6 点在 StoneDB GitHub discussions 公示,同时同步至社群和 Slack。获奖名单也会在流动完结后更新至 StoneDB GitHub discussions。请关注社区资讯。

4. 所有奖品在流动完结后对立发放,StoneDB 小助手将会在流动完结后三天内分割您,流动期间您能够在 StoneDB 微信社群、slack 或 GitHub discussions 参加探讨,追踪流动进度。

PS:局部文档中尚未有内容,咱们诚意邀请社区的小伙伴一起内容共建,奉献整篇文档可取得社区整套周边(徽章 +POLO 衫 + 雨伞 + 背包)

五、规定阐明

1. 一个 issue 或 pr 仅提交一个问题,多个问题请不要在一次性提交。

2. 同样的问题在不同文档呈现,如果屡次提交,只算一个问题。

3. 同一问题多人反馈,按工夫排序靠前者为准。

4. 每个 issue 或 PR 请贴上对应问题类型的标签(如低错类 =P01,易用性 =P02,正确性 =P03,危险提醒类 =P04),以不便咱们验证和统计您的积分。

5.GitHub 上的所有提交和探讨请应用英文,中文 issue 或 PR 将视为有效,工作人员会提醒您用英文从新提交。

6. 以下问题视为有效:

  • 问题无奈定位
  • 问题无奈复现
  • 问题非首次反馈
  • 其余经社区审核断定有效的状况

六、其余举荐

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

正文完
 0