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

StoneDB Document Bug Hunting Season 1

2022-08-10 11:34:00 【InfoQ】

Dear friends in the community, the first season of StoneDB's document bug hunting activity is now online with its peripherals!!!

On June 29, StoneDB held an online press conference to officially announce open source.Although preparations have been made before open source, bugs are still inevitable.In the past month or so, we have received a lot of various error reports due to document problems. While answering questions for community users, we also checked the relevant document content and made corrections at the first time.Considering that this revision may not be able to solve all the pain points in the documentation 100%, in order to find out these potential loopholes, 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 community partners to use their keen eyes to improve the community documents together!Build an open source community that belongs to everyone!

Participate in the StoneDB document bug hunting activity, submit valid issues or PRs to get the corresponding points, you can exchange the exquisite peripheral gifts of the community, and 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!

1. Activity registration

Add the StoneDB assistant (StoneDB_2022) as a WeChat friend, send your "GitHub username + registration document bug hunting activity" andFollow the official account, that is, the registration is successful.

Event time: August 9th to September 12th

2. Participate in the event

1. Raise issue

Please read the documentation of StoneDB first, and find any errors in the documentation. Go to the documentation repository of StoneDB to file an issue. Before submitting, please search whether the issue has been recorded.

2. Submit a PR

Please confirm the document problem that needs to be solved, and a corresponding issue is required.Fork the StoneDB repository and fix the issue, then submit a PR.In addition to the issues submitted by yourself, other unresolved issues can also be claimed and submitted as PRs~

3. Document warehouse 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

Note: This document is limited to version 5.7.

Three. Points rules

1. Low error type questions:

1 point for each issue and 2 points for each PR.

● Typos, spelling mistakes, abnormal link errors, disordered document format, etc.

● The expression is not smooth, but does not affect understanding

2. EasyUsability issues:

3 points per issue, 5 points per PR.

● Key steps are wrong or missing, unable to guide users to complete tasks

● Necessary prerequisites, precautions, etc. are missing

● Code errors in the document, such asLess spaces, less quotation marks, etc.

3. Correctness issues:

5 points for each issue and 8 points for each PR.

● The description is ambiguous and the logic is unclear

● There are errors in the schematic diagram, architecture diagram, function, etc.

● The description of the key parameters is wrong, and the user cannot be guided to complete theTasks

4. Risk prompt questions:

8 points for each issue and 12 points for each PR.

● Operation with special risk to important data or system, lack of safety tips

4. Prize exchange

Badge = 5 points; POLO shirt = 10 points; automatic umbrella = 15 points; backpack = 20 points (if there are remaining points, it can be redeemed repeatedly);

Contestants outside of China cannot receive physical prizes due to logistics restrictions.However, the StoneDB community has prepared a certificate of honor and a thank you letter for you, which will be sent to you by email, and you will also be exposed as a contributor on the official website.

If your issue or pr is valid, you can get the corresponding points. The points list will be announced on StoneDB GitHub discussions at 6:00 every night, synced to both the community and Slack.The list of winners will also be updated to the StoneDB GitHub discussions after the event.Please pay attention to community information.

All prizes will be distributed after the event. The StoneDB assistant will contact you within three days after the event.Participate in discussions in the WeChat community, slack or GitHub discussions and track the progress of the activity.

PS: There is no content in some documents yet, we sincerely invite community partners to build the content together, and contribute the entire document to get the whole set of community peripherals (badges).+POLO shirt+umbrella+backpack)

V. Rule description

Only one issue or pr can be submitted. Please do not submit multiple issues at one time.

The same problem occurs in different documents. If it is submitted multiple times, it is only one problem.

For feedback from multiple people on the same issue, the former shall prevail.

For each issue or PR, please label the corresponding issue type (such as low error class=P01, ease of use=P02, correctness=P03, risk reminder category =P04), so that we can verify and count your points.

All submissions and discussions on GitHub should be in English, Chinese issue or PR will be considered invalid, and the staff will remind you to resubmit in English.