openEuler 文档捉虫 2.0 上线啦，一键式提交 PR，成为开源贡献者，你也可以参与，文档伴读方案正式开源！

Posted 2022-10-18

hi~ 各位小伙伴 openEuler 文档捉虫 1.0 活动自 4 月开展以来，将 openEuler 官网和 Gitee 平台连结，自动创建 issue，解决了之前需要在两个平台之间来回跳转，提交 issue 步骤繁琐的问题。大家在这里阅文档、学知识、提 bug，帮助我们不断地完善文档，提供更易用的文档给开发者。

但在 openEuler 文档捉虫 1.0 体验过程中，一些开发者发现如果想直接修改文档中的问题，必须要将文档源代码 fork 到本地，并且要执行许多代码提交的 git 操作，这样会影响阅读体验。

现在 openEuler 文档捉虫 2.0 上线啦，提交 PR 像提交 issue 一样方便！小伙伴发现文档有问题，不管是大建议、还是小改进，直接线上修改文档提交 PR 即可，让大家更直接地参与文档修改，成为开源贡献者。

同时我们将文档捉虫代码在 Gitee 建立文档伴读代码仓[1]，以完整的开源解决方案呈现给大家，供大家参考和使用。希望帮助更多的开源社区，提升开源文档的读者体验！###如何参与：1.打开 openEuler 官方文档[2]，阅读自己感兴趣的文档。2.选中存在问题的文档片段，单击出现的图标，在弹出窗口中填写相关信息。3.单击“提交”按钮（需保持 Gitee 登录状态），跳转到 Gitee Web IDE 的 PR 提交页面（需要修改文档片段，会高亮显示）。4.暂存更改文件后创建提交 PR 即可。5.PR 一旦合入，将会获得贡献积分。（记得提交 PR 后，需要签署 openEuler 的贡献者协议，才能合入代码哦哦，点我签署[3]

奖项设置

说明：openEuler 文档捉虫活动官网[4]可查看积分和排名。

「月度」

星耀奖：积分前 10%，获得认证徽章及相应奖品。 攀登奖：积分前 10% - 30%，获得认证徽章及相应奖品。 幸运盲盒奖：所有提交有效 issue 或者 PR 的小伙伴，均可参与抽奖，每月抽取 3 名开源幸运奖，获得相应奖品。 特殊贡献奖：PR 积分 Top10，获得认证徽章及相应奖品。（华为 6 手环一只）

「季度」

问鼎奖：积分前 Top 10，获得认证徽章及相应奖品。

积分规则

「一、规范问题和低错类」

每个 issue 2 分、每个 PR 3 分。例如：

错别字或拼写错误；标点符号使用错误 链接错误、空单元格、格式错误 英文中包含中文字符 界面和描述不一致，但不影响操作 表述不通顺，但不影响理解 版本号不匹配：如软件包名称、界面版本号

「二、易用性问题」

每个 issue 5 分、每个 PR 8 分。例如：

关键步骤错误或缺失，无法指导用户完成任务 缺少必要的前提条件、注意事项等 描述存在歧义 图形、表格、文字等晦涩难懂 逻辑不清晰，该分类、分项、分步骤的没有给出

「三、正确性问题」

每个 issue 5 分、每个 PR 8 分。例如：

技术原理、功能、规格等描述和软件不一致，存在错误 原理图、架构图等存在错误 命令、命令参数等错误 命令无法完成对应功能 界面错误，无法指导操作

「四、风险提示类问题」

每个 issue 8 分、每个 PR 12 分。例如：

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

「五、内容合规类：」

每个 issue 10 分、每个 PR 12 分。例如：

违反法律法规，涉及政治、领土主权等敏感词 内容侵权 文档不好懂？提 PR 吧！文档不能指导我操作？提 PR 吧！文档存在错别字、错误标点？提 PR 吧！…… 赶快参与吧，在开源社区留下你的身影~~

相关链接

openEuler 官方文档: https://docs.openeuler.org/zh/ openEuler docs 仓库：https://gitee.com/openeuler/docs

Reference

[1] 文档伴读代码仓: https://gitee.com/openeuler/docs-accompany-reading

[2] openEuler 官方文档: https://docs.openeuler.org/zh/

[3] 点我签署: https://clasign.osinfra.cn/sign/Z2l0ZWUlMkZvcGVuZXVsZXI=

[4] openEuler 文档捉虫活动官网: https://docs-bug.openeuler.sh/