Dear MindSpore developers
This activity, hosted by the MindSpore community, aims to help developers and MindSpore form a virtuous cycle of cooperation from error correction to document readability improvement and make progress together.
You are welcome to create issues/PRs no matter whether it is a technical issue or a spelling error. We sincerely look forward to the participation of every partner.
Each issue and PR will be an impressive contribution to the MindSpore community. Don't hesitate to join us.
A. Find bugs and create an issue.
1. Browse tutorials and documents on the MindSpore official website.
2. Select a segment and click the icon that appears. In the dialog box that is displayed, enter information about the bug you may find, set Submit As to Issue, and select a bug type.
3. Click Submit. The content is automatically copied and the issue creation page of the MindSpore code repository on AtomGit is displayed.
4. Log in to AtomGit. The copied content is automatically pasted to complete issue creation.
B. Create a PR to resolve bugs.
1. Browse tutorials and documents on the MindSpore official website.
2. Select a segment and click the icon that appears. In the dialog box that is displayed, enter information about the bug you may find, set Submit As to PR, and select a bug type.
3. Click Submit. The content is automatically copied and the Web IDE of the MindSpore code repository on AtomGit is displayed.
4. Log in to AtomGit. The copied content will be automatically pasted. On the editing page, resolve bugs. Click "Submit Changes", and create a PR. For details, see AtomGit guidance
- Documentation scope:
- MindSpore Installation Guide
- MindSpore Documentation
- MindSpore Tutorials
This activity adopts the bonus point system. Bonus points will be accumulated for valid issues and PRs.
Description:
- MindSpore community staff will comment on valid issues or PRs.
- Monthly award. Only the bonus points of the current month are calculated.
- Only merged PRs and issues with "Documentation Improvement" in the title and valid comments from community staff can earn points.
- For the same bug, the earliest valid committer can earn points.
- For the same bug in different branches, only the issue/PR in one branch can earn points.
- If an issue and a PR are committed for the same bug at the same time, only the PR can earn points.
- If there is any malicious participation, the committer will be disqualified.
- The MindSpore community reserves the right to interpret this activity. If you have any objection, contact the staff.
| No. | Item | Bonus Point |
|---|---|---|
| 1 | Specifications and Common Mistakes: - Misspellings or punctuation mistakes,incorrect formulas, abnormal display; - Incorrect links, empty cells, or wrong formats; - Chinese characters in English context; - Minor inconsistencies between the UI and descriptions; - Low writing fluency that does not affect understanding; - Incorrect version numbers, including software package names and version numbers on the UI. | 2 points per issue 3 points per PR |
| 2 | Usability: - Incorrect or missing key steps; - Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions; - Ambiguous descriptions, unclear reference, or contradictory context; - Unclear logic, such as missing classifications, items, and steps. | 2 points per issue 3 points per PR |
| 3 | Correctness: - Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation; - Incorrect schematic or architecture diagrams; - Incorrect commands or command parameters; - Incorrect code; - Commands inconsistent with the functions; - Wrong screenshots; - Sample code running error, or running results inconsistent with the expectation. | 5 points per issue 8 points per PR |
| 4 | Risk Warnings: - Lack of risk warnings for operations that may damage the system or important data. | 8 points per issue 12 points per PR |
| 5 | Content Compliance: - Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions; - Copyright infringement. | 10 points per issue 12 points per PR |
a prize worthy CNY50.
The top five point winners are awarded.
a prize worthy CNY500.
Committers of issues/PRs that have made significant improvements to documents after review are awarded.
To be announced soon