Github上一些使用技巧(缩写、Issue的Highlight)自用

1. GIthub中的一些缩写 LGTM !

最近经常看到一些迷之缩写,感觉挺有意思的,但是有时候看到一些没见过的缩写还是有点懵逼,不过缩写确实也是很方便去review,这里就记录汇总一下;顺便加了一些git的基操单词(加粗的是我遇到比较多的)。

参考:
https://blog.csdn.net/liwenlong_only/article/details/104004928
https://blog.csdn.net/misayaaaaa/article/details/102684348
https://github.com/orgs/community/discussions/16925

缩写 含义 说明
PR Pull Request 拉取请求,用于向其他项目提交代码
LGTM Looks Good To Me 代码已经过review,可以合并
SGTM Sounds Good To Me 与LGTM意思相近,表示通过了review
WIP Work In Progress 如果你有个改动很大的 PR,可以在写了一部分的情况下先提交,然后在标题里写上 WIP,以告诉项目维护者这个功能还未完成,方便提前 review 部分已经写好的代码
PTAL Please Take A Look 你过来瞅瞅?
TBR To Be Reviewed 提示维护者进行review
TL;DR Too Long; Didn't Read 太长懒得看,通常用于文档的简略描述前
TBD To Be Done/Defined/Discussed/Decided/Determined 根据语境不同意义有所区别,但一般都是还没搞定的意思
BTW By The Way 顺便说一下
FYI For Your Information 供你参考
CC Carbon Copy 抄送,用于提及某人以便其了解相关信息
API Application Programming Interface 应用程序编程接口
CI/CD Continuous Integration/Continuous Deployment 持续集成/持续部署
CR Code Review 代码审查
Doc Document 文档
Fork 创建一个项目的副本到自己的账户下
Repo Repository 存储代码和其他资源的仓库
HEAD 指向当前检出分支的最新提交
Merge 将一个分支的更改合并到另一个分支中
Rebase 将一系列提交应用到另一个基础分支上,通常用于整理提交历史
Issue 用户报告的问题或者待办事项,可以是Bug报告、功能请求等
Label 用来标记Issues或PRs的分类标签,帮助组织和跟踪任务
RFC Request For Comments 请求意见稿,一般是一个Markdown文件

2. Issue中的一些 Highlight

复制代码
> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
相关推荐
数字冰雹11 分钟前
图观 流渲染打包服务器
服务器·前端·github·数据可视化
白鲸开源13 分钟前
3.1.8<3.2.0<3.3.1,Apache DolphinScheduler集群升级避坑指南
java·开源·github
计算机小手2 小时前
推荐一个 GitHub 开源项目信息卡片生成工具,支持Docker快速部署和API调用
经验分享·docker·github·开源软件
ssshooter2 小时前
GitHub 删除无法访问的 mention
github
绝无仅有4 小时前
面试真实经历某节跳动大厂Java和算法问答以及答案总结(一)
后端·面试·github
绝无仅有4 小时前
某大厂跳动面试:计算机网络相关问题解析与总结
后端·面试·github
Cosolar12 小时前
FunASR 前端语音识别代码解析
前端·面试·github
(・∀・)16 小时前
如何配置 GitHub 远程仓库及本地 Git 环境
github
赴前尘16 小时前
Go 微服务框架排行榜(按 GitHub Star 排序)
微服务·golang·github
idaibin18 小时前
"Git 多仓库用户身份自动切换与隐私保护指南
git·github