公开记录中的每一个仓库都配有可嵌入的徽章:一枚小型 SVG 图像,显示当前的健康指数与评级等级,并链接回完整报告。徽章让这份记录在决策发生之处清晰可见——在 README 中,紧邻安装说明。
嵌入徽章
每个报告页面都为其仓库提供可直接复制的代码片段。格式如下:
[](https://inspect.software/software/OWNER/REPO)
<a href="https://inspect.software/software/OWNER/REPO">
<img src="https://raw.githubusercontent.com/inspect-software/badges/main/v1/O/OWNER/REPO.svg"
alt="inspect.software health badge for OWNER/REPO" />
</a>
将 OWNER/REPO 替换为仓库的完整名称,并将 O 替换为所有者名称的首字母(小写)——徽章按该字母归档,以免仓库中任何单个目录膨胀到无法浏览。直接从 公开记录中该仓库的报告页面复制现成的代码片段,可避免出错。
shields.io
对于统一使用 shields.io 徽章的 README,这份记录也可通过 shields 的 endpoint 徽章获取。每个仓库都在 https://inspect.software/badge/v1/OWNER/REPO.json 以 endpoint JSON 的形式提供其当前状态,由 shields 以其自身的视觉语言渲染:
[](https://inspect.software/software/OWNER/REPO)
渲染出的徽章标明与原生徽章相同的指数、等级词汇与等级颜色——已认证仓库以其字母评级领衔——并按同样的每小时节奏刷新。shields 的所有样式参数(style=、logo= 等)与任何其他 shields 徽章一样适用。
徽章的行为
- 始终保持最新。徽章反映最近一次发布的检验结果,并在每次扫描后自动更新——无需重新嵌入。
- 由 GitHub 提供。徽章图像发布于公开仓库 inspect-software/badges,并由 GitHub 自有的内容分发网络送达。嵌有徽章的 README 不依赖本站是否可访问。
- 版本化路径。
/v1/路径段保持稳定;徽章语义的任何未来变更都会以新版本的形式发布,绝不悄然更改。 - 随等级着色。徽章采用仓库当前等级的颜色,从代表卓越的深绿色到代表危急的红色,并在指数旁以文字标明等级。
- 已认证仓库带有印记。处于前三个等级的仓库会显示一枚压印徽记,其上为该仓库的字母评级——A、AA 或 AAA——即其 认证级别的可见标志。该印记是认证标志,因此低于良好的仓库不带印记;其徽章只标明等级与指数。
- 尺寸唯一且固定。无论指数为何,每枚徽章都是 137×20 像素,因此指数变动时 README 绝不会重排,一排徽章也始终齐平。
- 绝不失效。尚未进入记录的仓库会显示一枚中性徽章,而不是一张损坏的图片。
徽章所声明的内容
徽章所声明的,与其背后的报告所声明的完全一致:依据 版本化方法论衡量的、公开可见的实践——仅此而已。它是供审阅参考的信号,而非质量或安全的担保(参见信号,而非担保)。链接指向的报告始终展示完整的类别概览、每项指标的组成部分以及原始数据。