由OpenHarmony 文档上的PR三天未处理引发的思考

简介: 前段时间我不是教大家完成一个 OpenHarmony 代码的贡献流程,结果我自个的PR已经三天了还没处理到,这不得不引发我的思考,到底是啥原因导致的呢(事实上确实就是一个很随便的PR),所以这次带大家重新学习一下,文档需要的真正规范

一、前言

前段时间我不是教大家完成一个 OpenHarmony 代码的贡献流程,结果我自个的PR已经三天了还没处理到,这不得不引发我的思考,到底是啥原因导致的呢(事实上确实就是一个很随便的PR),所以这次带大家重新学习一下,文档需要的真正规范(显式的文档规范)和PR的常见问题,OpenHarmony审核人员对这个文档的审核很仔细,甚至仔细到一个标点符号,在此为工作人员点赞,正文即将开始~~

二、一些常见的问题

1.系统判错

这部分很多时候就是自身的问题了,比如dco没有签署协议,这个按照提示处理一下即可

在这里插入图片描述

还有就是可能忘记编译了,即需要评论里面输入start build,由于我们贡献的是文档,所以一般情况下是不会有编译等问题,如果没有编译,成功,可能你的PR就会很久都得不到解决,像下面这位老哥,忘记编译了,结果两个月了还在这里

在这里插入图片描述

格式化和静态检查一般的错误类似,英文文档出现中文中文就会出现格式化检查失败

2.文字内容

  • 标点符号

    这里常见的错误就是中英文的标点符号,类似

    ,和,
    ""和“”
    ''和‘’
    .和。
    ()和()

    这里的话,如果在英文中出现中文的标点符号的话相当明显

  • 简称与全称

    在首次出现的时候最好两个都要,其中一个不在下文出现的用括号括起来例如

    TCP(Transmission Control Protocol)

  • 样式统一

    首先全局的大小写命名统一,不能出现不一致的情况,其次就是某些专有名词必须遵循特定的大小写规则,类似OpenHarmony必须两个首字母都进行大写。

三、一些失败的案例

  • 大小写没补充完整

    在这里插入图片描述

  • 图片命名不规范

    在这里插入图片描述

  • 中英文混合

    在这里插入图片描述

  • dco未签署

    在这里插入图片描述

  • 缩进问题

    我们的工作人员好细心

    在这里插入图片描述

  • 前后注释不一致

    /**/这种块注释类似java 中的api说明,//行注释是比较一般的注释

    在这里插入图片描述

四、带给我们的思考

开源的项目正因为有这些工作人员和开发者的贡献才会越来越好,同时,在贡献文档的同时也会有各方面的讨论,一个个思维的碰撞,最初看到这些未合并下的对话,真的有被震撼到,我原本以为审核是很松的,毕竟这么大一个项目,需要投入很多的精力,不太可能如此认真的检查,长见识了,虽然有时候我们也有点气,他为什么不一次性都讲完全部的问题,现在其实已经释然了,只有更加优质的作品才能得到肯定,每一次提交都是一次次进步,这里我甚至看到提交好几个月的,最后还没合并的,respect

五、总结

现在想想我的那个PR确实不太行,就改了几句话,可能也没那么重要,不过还是有点遗憾,毕竟看了一周,PR在不断的下降,我的PR还是没有合并,释怀了,再过几天就去关一下。精益求精,相信OpenHarmony这样开源的项目会越来越好的。

目录
相关文章
|
3月前
|
Kubernetes 测试技术 Go
sealos issue #2157 debug 思路流程记录
sealos issue #2157 debug 思路流程记录
48 0
|
3月前
|
编解码 Ubuntu
记录一次Gstreamer运行报错排查
记录一次Gstreamer运行报错排查
|
3月前
|
开发工具 git
【Github】sync fork后,意外关闭之前提交分支的pr申请 + 找回被关闭的pr请求分支中的文件
【Github】sync fork后,意外关闭之前提交分支的pr申请 + 找回被关闭的pr请求分支中的文件
53 5
|
网络安全
给开源项目提交pr
给开源项目提交pr
171 1
给开源项目提交pr
|
iOS开发 MacOS
使用 google_breakpad 分析 Electron 崩溃日志文件
本机(MacBook Pro)上 Electron 的路径:/usr/local/lib/node_modules/electron/dist/Electron.app/Contents/MacOS/Electron
1170 1
使用 google_breakpad 分析 Electron 崩溃日志文件
|
Web App开发 JavaScript 前端开发
前端BUG录- audio 意外的 Pending 挂起状态
最近公司一直在做众审平台相关的功能,大多数还都和音视频有关,前端终究还是逃不过这一劫。 疯狂遇到 BUG, 今天来说说其中一个:audio 加载时意外的长时间 Pending 问题。
306 0
dwz切换页数时bug修复过程
dwz切换页数时bug修复过程
104 0
|
监控 Android开发
AndroidStudio无法输出日志的Bug
QQ截图20180309150706.png 正常情况下我们在真机调试程序时,如图箭头所指的位置显示的应该是该应用的主包名,但是有的时候明明打开了开发者模式,但是却无法输出日志,该位置显示的也不是应用包名,显示的是 no debuggabl...
1257 0
|
Python 数据安全/隐私保护 API
JIRA python篇之统计产品尚未解决的bugs
[本文出自天外归云的博客园] 通过python中的jira类我们可以方便的操作jira,获取一些我们想要再加工的信息。 一些通过JIRA的JTL查询语句不方便直接搜索的过滤条件可以通过JIRA的python api来完成。
1733 0