Code Review 文化人语录

前言

这些缩写在代码审查过程中可以帮助快速传达意见和反馈，提高沟通效率。然而，对于新手或不熟悉这些缩写的人来说，它们可能会引起困惑。因此，了解这些常见的缩写及其含义对于参与代码审查是非常有帮助的。

缩写

WIP：代表 “Work In Progress”，意思是“进行中的工作”。这通常用于标记尚未完成或需要更多工作的拉取请求。

LGTM：代表 “Looks Good To Me”，意思是“对我来说看起来不错”。这是一种表示代码审查者已经审查了更改并认为它们可以合并的方式。

NIT：代表 “Nitpick”，意思是“吹毛求疵”。这通常用于指出一些小的、非阻塞性的问题，这些问题不值得阻止代码的合并，但值得注意并在以后的版本中修复。

TODO：是一种标记，用于指出代码中仍然需要完成或修复的部分。这通常是为了提醒开发者在未来回来完成这项工作。

FIXME：是一种标记，用于指出代码中存在问题，需要修复。这通常是因为代码中存在错误或不良实践，需要尽快解决。

PTAL：代表 “Please Take A Look”，意思是“请看一下”。这是一种请求其他人审查代码更改的方式。

ACK：代表 “Acknowledgement”，意思是“承认，同意”。表示接受代码的改动。

NACK：代表 “Negative Acknowledgement”，意思是“不同意，不接受”。表示不赞成或不同意代码的改动。

RTFM：代表 “Read The F***ing Manual”，意思是“读该死的手册”。这通常用于指出某个问题或错误可以通过阅读相关文档或手册来解决。

YMMV：代表 “Your Mileage May Vary”，意思是“你的结果可能会有所不同”。这通常用于指出某个解决方案或建议可能不适用于所有情况，具体效果可能会因人而异。

TBC：代表 “To Be Continued”，意思是“待续”。这通常用于指出某个讨论或问题还没有得出最终结论，需要进一步探讨或调查。

FYI：代表 “For Your Information”，意思是“供参考”。这通常用于提供一些与当前讨论或问题相关的信息，但不一定需要采取任何行动。

STALE：代表 “Stale”，意思是“陈旧的，过时的”。这通常用于标记长时间没有更新或响应的代码审查请求或问题。

TL;DR：Too Long; Didn’t Read 「太长懒得看」，README 文档常见。

其他

• https://github.com/songjiayang/review-abbreviation
• https://www.freecodecamp.org/news/what-do-cryptic-github-comments-mean-9c1912bcc0a4/