有人说过,优秀的程序员是懒惰的,他们总是找到一件事情中的规律,然后用最简单的方式解决它;在平时的交流中更是如此,所以很多人认为他们很难交流。
那么你是否注意到在 Github
的 issues
和 PR
中经查出现一些缩写吗?
这里,我们就收集一些在社区交流中经查用到的一些缩写,有的在配合CI/CD
的工具下,已经实现了丰富的功能,一些则经常用在平时的交流中。
我们简单的将常用的,和一些高级玩家用的分开来,让我们使用一些常用的缩略语以提高交流效率,避免的使用一些低频率缩略语,为别人减少一些疑惑。
常见缩略语
PR
PR
Pull Request.
这是 Github
中的一个常用功能,合并拉取请求,用以发起将自己的分支合并到主干分支的请求,请求对方将你的代码 Merge
到他的主干分支。
GitLab
中对应的是 merge_requests
,都是当前贡献代码的主要手段。
Github 中有关于 Pull Request
有一个详细的说明,刚兴趣的话可以仔细研读下:about-pull-requests
WIP
WIP
Work in progress, do not merge yet.
出现在 PR 的标题中,用于提示审核人,进行中暂时不要合并;Github
和 GitLab
均以对此缩略语提供了自动化支持,在标题中出现时,将禁用合并按钮。
在开源项目中,如果计划贡献代码,请在开始时,就准备一个 PR,并贴上你的计划和目的描述,在标题开头标注 WIP:
以同步给与你有同样想法的人,避免重复的工作。
LGTM/SGTM
LGTM
Looks good to me.SGTM
Sounds Good To Me.
通常出现在 PR
的评论里,表示对提交者的赞许,鼓励他更多的参与贡献。
正如语气 在我看来很好
所以大多是审核者或者项目所有者对贡献者的鼓励,请在评论别人的 PR
时斟酌一二。
CC
CC
Carbon copy
CC
可能是来自邮件沟通中的缩略语,表示抄送的意思,希望某人也能收到,了解相关信息,通过 cc 后续的 @
At 出对应的成员,他可以再自己的通知中收到相关信息,并知晓有消息抄送给他。
实例: cc @dingdayu 这里的消息看一下
其他缩略语
下面所列也是常见缩略语,但受于篇幅和时间,将不对其做更多的着墨,相信大家根据注释都能有所体会,有兴趣的话,可以在社区多多尝试一下。
TL;DR
Too Long; Didn't Read. // 太长懒得看。也有很多文档在做简略描述之前会写这么一句PTAL
Please take a look. // 帮我看下,一般都是请别人 review 自己的 PRDNM
Do not merge. //不要合并CL
Changelist. // 修改的文件CS
Changeset. // 和CL 类似ACK
acknowledgement. // 我确认了或者我接受了,我承认了RFC
request for comments. // 我觉得这个想法很好, 我们来一起讨论下IIRC
if I recall correctly. // 如果我没记错NACK/NAK
negative acknowledgement. // 我不同意TBR
To Be Reviewed. // 提示维护者进行 reviewTBD
To Be Done(or Defined/Discussed/Decided/Determined). // 根据语境不同意义有所区别,但一般都是还没搞定的意思IMO
In My Opinion. //在我看来、依我看、依我所见IMHO
In My Humble Opinion IMO. //谦虚的说法,以我的拙见(多用于邮件和网络)AFAIK/AFAICT
As Far As I Know / Can Tell. //据我所知FYI
For your information. //供你参考AFK
Away From the Keyboard. //稍后回来IANAL
I am not a lawyer, but I smell licensing issues. // 我不是律师,但是我闻到了许可问题
不推荐的用法
这里的不推荐只是作者本人认为有更好的方式表达,且操作存在相关争议,建议大家不要这样使用,并不代表官方说法,请仅供参考。
LGT1
Looks Good To 1. //如果有一个回复 LGTM 则可以添加为 LGT1,1 代表目前有 1 个赞LGT2
Looks Good To 2. //如果有两个回复 LGTM 则可以添加为 LGT2,2 代表目前有 2 个赞
建议
使用 GitLab
和 Github
中提供的 enjoy
表情的功能,表达你的观点。
其中 Github
上在评论(issues
,PR
均可)的右上角提供一个 表情图案(Pick your reaction
),提供了几个预选表情,你可以选择你的观点,也可以再评论的下方,别人的观点中进行+1
等操作。
GitLab
则在响应的位置提供了 👍/👎 或添加新的观点的功能。