Home
>
黑河文档管理
>
黑河github 文档管理
黑河github 文档管理

time:2020-08-04 10:41:07

author:重庆佰鼎科技有限公司

【Font size: big medium smail

本文由重庆佰鼎科技有限公司提供,重点介绍了github 文档管理相关内容。重庆佰鼎科技有限公司专业提供广州文档管理,客户管理文档,优秀文档管理等多项产品服务。从成立至今,服务过多项优质客户,提供一站式服务,选择我们享受一次完美的消费体验。

github 文档管理大家好,我是小 G。

今天跟大家分享一份来自 Google 团队的工程实践文档:Google's Engineering Practices documentation。

这份文档积累自 Google 团队长期以来的内部项目最佳实践,其目的在于帮助开发者更好的做好代码审查工作,通过 Code Review 来提升并优化当前项目的代码质量,也便于后续开发人员的维护与管理。

其实,代码审查这件事,长期以来在国内一直没有得到其应有的重视,不少开发者或项目经理,都觉得没有必要在代码审查这件事情上投入过多精力,认为摆在他们面前有更为重要与紧急的事情要去处理。

一般对这件事情的最终处理方式,就是一直拖着。拖到某一天,突然发现项目体积过大,新增功能成本过高,代码过分冗余,可维护性越来越差,这时才不得不狠下心来,对项目代码进行重构,每当项目经过这么一番折腾,伤筋动骨那都是在所难免的。

既然这样,为何不从一开始就在团队内部设立好代码审查机制,定期抽出时间来对项目代码进行全方位的盘查呢?

如果你跟小 G 想的一样,那 Google 的这份代码审查指南对你来说,再合适不过了。

这份指南主要拆分为两大块:github 文档管理github 文档管理

代码审查者指南代码开发者指南前者主要为你讲解代码审查的几项标准与要点,后者则是教会你如何使用 CL,维护好代码审查的基本流程。

在 Google 工程师看来,代码审查者应该对项目的设计、功能、复杂度、测试、命名、注释、风格、文档等几大要素进行重点关注。

如果一步步做好这几件事,指南里面均有提及,这里便不多做赘述了。

目前 Google 的这份文档已正式开源到了 GitHub 上,并且还基于 GitHub Pages 构建了文档的静态站点。

此外,英文不太好的同学也不用过于担心,国内有开发者已将这份指南翻译成了中文,下面是该项目的完整链接,感兴趣的同学可以看一下。

中文版:https://jimmysong.io/eng-practices/ 英文版:https://google.github.io/eng-practices/GitHub 地址:https://github.com/google/eng-practices--

文末,照旧安利一波我们的公众号:GitHubDaily,目前每天都会在上面更新至少 3 篇文章,主要分享比较实用或有趣的开发工具与开源项目,偶尔也会聊聊技术圈内最近发生的新鲜事,感兴趣的小伙伴可以关注一下哈。

Reprint please indicate:http://auub.cnsoftweb.com/wdgl-3657.html