Github - 记录一次向字节跳动CloudWeGo文档贡献的commit
Github - 记录一次向字节跳动CloudWeGo文档贡献的commit
前言
和好朋友们做项目时学习Kitex
看cloudwego
文档,发现文档中有注释未对齐:
有点强迫症(bushi) 于是想着给文档项目提个PR。
过程
按正常流程:提issue,Fork了该项目,clone到本地,新建分支,修改并commit,提PR,签署CLA
协议,等待Approve和merge。
其实两周前(2025.1.30 8:34)就想提了,今天终于实行了当时想干的。
ToSay
虽然提的是一个小更改,但是:
字节Cloudwego文档项目反馈真的好及时!提了一个issue,十几分钟就收到了回复,几十分钟就CR
通过,并且merge了!点赞👍
现在中英文这里的注释都对齐了:
附一些Github的谜之缩写(黑话)
本次PR和issue全程参考其他已merge的PR或issue进行,其间看到了Approve时留下的messageLGTM
,搜了一下后发现了一些Github的谜之缩写。
缩写 | 全称 | 含义 |
---|---|---|
PR | Pull Request | 拉取请求,给其他项目提交代码 |
LGTM | Looks Good To Me | 朕知道了,代码已经过 review,可以合并 |
SGTM | Sounds Good To Me | 和 LGTM 意思差不多,也是已经通过了 review 的意思 |
WIP | Work In Progress | 传说中提 PR 的最佳实践是,如果你有个改动很大的 PR,可以在写了一部分的情况下先提交,但是在标题里写上 WIP,以告诉项目维护者这个功能还未完成,方便维护者提前 review 部分提交的代码 |
PTAL | Please Take A Look | 你来瞅瞅?用来提示别人来看一下 |
TBR | To Be Reviewed | 提示维护者进行 review |
TL;DR | Too Long; Didn’t Read | 太长懒得看。也有很多文档在做简略描述之前会写这么一句 |
TBD | To Be Done (or Defined/Discussed/Decided/Determined) | 根据语境不同意义有所区别,但一般都是还没搞定的意思 |
缩写来源:CSDN@misayaaaaa
End
我的一些其他贡献(记录在册):
Github贡献👆
同步发文于CSDN和我的个人博客,原创不易,转载经作者同意后请附上原文链接哦~
Tisfy:https://blog.letmefly.xyz/2025/02/14/Other-Github-Record1Contribution2BytedanceCloudwegoDocs/
Github - 记录一次向字节跳动CloudWeGo文档贡献的commit
https://blog.letmefly.xyz/2025/02/14/Other-Github-Record1Contribution2BytedanceCloudwegoDocs/