昇思MindSpore文档反馈活动,2024重磅来袭
昇思MindSpore文档反馈活动,2024重磅来袭
简介
致各位昇思MindSpore开发者们
本活动由昇思MindSpore社区主办,旨在帮助开发者与昇思MindSpore之间形成纠错、修正、完善的良性循环合作关系,进一步提高文档的可阅读性,促进开发者和我们共同进步。
欢迎大家提出Issue/PR,不论您是技术问题,还是错别字的修正都是对我们的大力支持,真诚期待每一位小伙伴的参与。
您的每一个 Issue、每一个 PR ,都将是昇思MindSpore社区文档贡献中闪亮发光的星星。心动不如行动,赶紧加入我们吧~~
如何反馈
A: 找bug,提Issue
1. 浏览MindSpore官网教程和文档进行学习;
2. 选中存在问题的文档片段,点击出现的图标,在弹窗中填写相关信息,选择 “提交类型”为Issue,选择问题类型;
3. 单击“提交”按钮,会自动拷贝内容并跳转到Gitee MindSpore代码仓库Issue提交页面;
4. 登录Gitee,会自动粘贴复制内容,完成Issue创建。
B: 提PR,解bug
1. 浏览MindSpore官网教程和文档进行学习;
2. 选中存在问题的文档片段,点击出现的图标,在弹窗中填写相关信息,选择 “提交类型”为PR,选择问题类型;
3. 单击“提交”按钮,会自动拷贝内容并跳转到Gitee MindSpore代码仓库Web IDE界面;
4. 登录Gitee,会自动粘贴复制内容,在“编辑”页面完成问题修改,在“提交”页面点击提交,完成PR创建,详细可参考 Gitee相关指导
问题反馈范围:MindSpore安装指南;MindSpore文档;MindSpore教程
积分规则
本次文档反馈活动采用积分制,将对有效的Issue和PR进行累计式积分。
说明:
- 针对有效Issue或PR,MindSpore社区工作人员会进行相关评论
- 月度评奖,仅计算当月积分,不累计
- 仅标题中带有“文档反馈”且得到社区人员评论有效的Issue和已合入的PR积分
- 同一个问题,最早有效提交者积分
- 不同分支的同一个问题,仅一个分支标准积分,其他分支的 Issue/PR 不积分
- 同一个问题若同时提Issue和PR,按PR积分,不能重复积分
- 若有恶意参加行为,则取消活动参加资格
- 该活动所有解释权归昇思MindSpore社区,如有异议可联系工作人员沟通
序号
积分项内容
积分内容
1
规范和低错类:
- 错别字或拼写错误,标点符号使用错误、公式错误或显示异常;
- 链接错误、空单元格、格式错误;
- 英文中包含中文字符;
- 界面和描述不一致,但不影响操作;
- 表述不通顺,但不影响理解;
- 版本号不匹配:如软件包名称、界面版本号;
每个 issue 2 分
每个 PR 3 分
2
易用性:
- 关键步骤错误或缺失,无法指导用户完成任务;
- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等;
- 描述内容存在歧义指代不明、上下文矛盾;
- 逻辑不清晰,该分类、分项、分步骤的没有给出;
每个 issue 2 分
每个 PR 3 分
3
正确性:
- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致;
- 原理图、架构图等存在错误;
- 命令、命令参数等错误;
- 代码片段错误;
- 命令无法完成对应功能;
- 界面错误,无法指导操作;
- 代码样例运行报错、运行结果不符;
每个 issue 5 分
每个 PR 8 分
4
风险提示:
- 对重要数据或系统存在风险的操作,缺少安全提示;
每个 issue 8 分
每个 PR 12 分
5
内容合规:
- 违反法律法规,涉及政治、领土主权等敏感词;
- 内容侵权;
每个 issue 10 分
每个 PR 12 分
奖项设置
本活动为长期活动,每个月度为一期并发放一次奖品,根据积分规则,每期将会统计在这个月度内用户的积分并进行排名,奖励分为火眼金睛奖和特殊贡献奖。
火眼金睛奖可获得价值50元的奖品
奖励规则:按照本月度内的积分从高到低进行排名,前五名可获得火眼金睛奖;
特殊贡献奖可获得价值500元的奖品
奖励规则:Issue/PR经评审后,对文档有重大改进的可获得特殊贡献奖;