当前位置:网站首页>StoneDB Document Bug Hunting Season 1

StoneDB Document Bug Hunting Season 1

2022-08-10 18:34:00 StoneDB

Friends of the community,StoneDB The first season of document catching bugs is online with peripherals!!!

6月29日 StoneDB An online conference was held,正式宣布开源.Although it is well prepared before open source,bug Still inevitable.In the past month or so, we have received too many various types of error feedback due to documentation problems,While answering questions for community users,We also checked the relevant document content and made corrections for the first time.Considering that this revision may not be able to solve all the pain points in the documentation 100%,in order to identify these potential vulnerabilities,We decided to hold this documentation bug hunt.As the saying goes, more people are more powerful,In order to give all community users a better experience,We sincerely invite our partners in the community to use Sharp Eyes,Improve community documentation together!Build an open source community that belongs to everyone!

参与 StoneDB Documentation bug hunt,提交有效 issue 或者 PR Get corresponding points,You can exchange for beautiful peripheral gifts in the community,At the same time, appear on the contributors page of the community official website together with the technical leaders,Let us look forward to your participation!

一、活动报名

添加 StoneDB 小助手( StoneDB_2022 )为微信好友,发送您的“ GitHub 用户名+Sign up for the document bug hunt”并关注公众号,即报名成功.

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

二、参与活动

1. 提 issue

请先阅读 StoneDB 的文档,Found errors in the documentation,前往 StoneDB 的 Documentation repository issue,Please search to see if this issue is already logged before submitting.

2. 提 PR

Please identify the documentation issue that needs to be resolved,需要有对应的 issue .Fork StoneDBrepo and fix the issue ,然后提交 PR.Except for your own submission issue ,Others have not yet been resolved issue It can also be claimed and submitted PR 哦~

3. Documentation repository address

Chinese document location:https://github.com/stoneatom/stonedb/tree/stonedb-5.7/website/i18n/zh/docusaurus-plugin-content-docs/current
English document location:https://github.com/stoneatom/stonedb/tree/stonedb-5.7/Docs

注:This document catches bugs5.7版本.

三、积分规则

1.Low error class problem:每个 issue 1 分、每个 PR 2 分.

  • 错别字、拼写错误、Link error exception、The document format is messed up, etc
  • 表述不通顺,但不影响理解

2.易用性问题:每个 issue 3 分、每个 PR 5 分.

  • 关键步骤错误或缺失,无法指导用户完成任务
  • 缺少必要的前提条件、注意事项等
  • Code error in document,For example less spaces、less quotes etc

3.正确性问题:每个 issue 5 分、每个 PR 8 分.

  • 描述存在歧义,逻辑不清晰
  • 原理图、架构图、There are errors in functions, etc
  • The key parameter description is wrong,无法指导用户完成任务

4.Risk warning category问题:每个 issue 8 分、每个 PR 12 分.

  • 对重要数据或系统存在特别风险的操作,缺少安全提示

四、奖品兑换

  1. 徽章=5个积分;POLO衫=10个积分;自动伞=15积分;双肩包=20个积分(If there are remaining points,Redeemable);
  2. Contestants from outside China,Due to logistics constraints,In-kind prizes are not available.但 StoneDB The community has prepared a certificate of honor and a letter of thanks for you,will be sent to you by mail,At the same time, you will also be exposed as a contributor on the official website.
  3. 如果您的 issue 或 pr 为有效,The corresponding points can be obtained,The standings will be on every night6点在 StoneDB GitHub discussions 公示,Simultaneously sync to the community and Slack .The list of winners will also be updated after the event ends StoneDB GitHub discussions .Please follow the community information.
  4. All prizes will be distributed uniformly after the event ends,StoneDB The assistant will contact you within three days after the event ends,You can be there during the event StoneDB 微信社群、slack 或 GitHub discussions 参与讨论,追踪活动进度.

PS:Some documents do not yet have content,We sincerely invite small partners in the community to build content together,Contribute the entire document to get a complete set of peripherals from the community(徽章+POLO衫+雨伞+背包)

五、规则说明

  1. 一个 issue 或 pr Submit only one question,Please do not submit multiple questions at once.
  2. 同样的问题在不同文档出现,如果多次提交,只算一个问题.
  3. 同一问题多人反馈,The former shall prevail in chronological order.
  4. 每个 issue 或 PR Please tag the corresponding question type(Such as low error class=P01,易用性=P02,正确性=P03,Risk warning category=P04),To facilitate us to verify and count your points.
  5. GitHub Please use English for all submissions and discussions on ,中文 issue 或 PR 将视为无效,Staff will remind you to resubmit in English.
  6. 以下问题视为无效:
  • 问题无法定位
  • 问题无法复现
  • 问题非首次反馈
  • Other situations that have been judged invalid by the community review

六、其他推荐

社区官网:https://stonedb.io/

代码仓库:https://github.com/stoneatom/stonedb

原网站

版权声明
本文为[StoneDB]所创,转载请带上原文链接,感谢
https://yzsam.com/2022/222/202208101802182766.html