评分类别

工程质量

工程质量类别——CI、测试、lint 与文档实践。权重:占 inspect.software 健康指数的 20%。

方法论 v1.13.0更新于 2026-07-13

工程质量衡量基线工程与文档实践是否到位:持续集成、自动化测试、 lint 与格式化纪律,以及新来者真正能够学习的文档。这些实践使变更变得安全——对人类贡献者如此,对 AI 编码代理 亦日益如此。

该类别承载总健康指数的 20%

本类别包含的指标

指标类别内权重在总指数中的权重
工程实践60%12%
文档40%8%

工程实践是对卫生证据的加权核查清单: CI 工作流、测试套件、linter 配置、pre-commit 钩子与 .editorconfig文档衡量项目是否会解释自己: README、文档目录或站点、仓库描述、主题标签与 wiki。

本类别有意度量的内容

这些信号是基于存在性的:它们确认基础设施存在,而非其优劣。这种克制是有意的——从外部为测试的质量或文档的文笔打分,将是把猜测包装成测量。存在性信号验证成本低、难以反驳,并且已经能相当出色地把严谨项目与松散项目区分开来。更深层的信号(覆盖率、CI 通过率)在方法论路线图之中,将随版本升级到来。

如何解读类别数值

  • 此处的低数值极少说谎:缺失 CI 与缺失测试是可见的事实,而非主观判断。
  • 高数值意味着质量的脚手架已经就位。它并不认证其中的代码是好的 ——参见信号,而非担保
  • 文档占 40% 的权重:一个测试完善却对新来者毫无解释的项目,其可采用性可测量地更低,该类别如实反映这一点。

提升工程质量

  • 添加在每次推送与拉取请求时运行测试套件的 CI——这是 工程实践中权重最高的两个组成部分。
  • 提交 linter 与格式化工具配置;添加 pre-commit 钩子与 .editorconfig 以获取满分。
  • 维护真实的 README、docs/ 目录或文档站点、仓库描述与主题标签 ——每一项都是文档中单独加权的组成部分。

相关条目:AI 就绪度 · 健康指数