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

57次阅读

共计 1625 个字符,预计需要花费 5 分钟才能阅读完成。

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/d…

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

[3]
点我签订:
https://clasign.osinfra.cn/si…

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

正文完
 0