在 10 秒内为你的 GitHub README 添加仓库健康徽章

Source: Dev.to

你一定见过每个 GitHub README 顶部的徽章吧？它们会告诉你构建是否成功、使用的许可证是什么。很酷。

但它们并没有告诉你真正重要的事情：

• 这个仓库是否在积极维护？
• 维护者对 issue 的响应速度如何？
• 是否有大量被忽视的 issue 堆积？
• 我是否真的应该依赖这个项目？

于是我制作了可以回答这些问题的徽章。

快速入门

将以下内容添加到你的 README 中（将 owner/repo 替换为你的仓库）：

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo.svg)](https://gitscope.dev)

就这样。无需注册。无需 API 密钥。无需配置。

→ 查看任意仓库的实时示例
→ 阅读文档

所有可用徽章

访问 gitscope.dev/badges 查看完整列表。

仓库健康分数

整体仓库健康度，范围 0‑100 %。结合活跃度、维护情况、社区参与度和问题管理。

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo/health.svg)](https://gitscope.dev)

维护状态

显示：very active | active | maintained | stale，基于最近的提交和 issue 活动。

[![Maintained](https://api.gitscope.dev/api/badges/owner/repo/maintained.svg)](https://gitscope.dev)

响应时间

基于活动的指标，显示仓库最近一次更新的时间。

[![Response Time](https://api.gitscope.dev/api/badges/owner/repo/response-time.svg)](https://gitscope.dev)

贡献者

直接从 GitHub API 获取的实际贡献者数量。

[![Contributors](https://api.gitscope.dev/api/badges/owner/repo/contributors.svg)](https://gitscope.dev)

友好贡献者

指示仓库是否欢迎新贡献者（good‑first‑issues、贡献指南、响应模式）。

[![Contributor Friendly](https://api.gitscope.dev/api/badges/owner/repo/contributor-friendly.svg)](https://gitscope.dev)

接受 Issue

显示项目是否积极接受并响应 issue 报告。

[![Issues Welcome](https://api.gitscope.dev/api/badges/owner/repo/issues.svg)](https://gitscope.dev)

文档质量

基于 README 完整度、wiki 是否存在以及链接的文档情况。

IMAGE.png)](PLACEHOLDER_FOR_DOCS_IMAGE)

[![Docs](https://api.gitscope.dev/api/badges/owner/repo/docs.svg)](https://gitscope.dev)

(将占位符 URL 替换为实际的 “Documentation Quality” 徽章图片 URL。)

自定义样式

添加 ?style= 以更改外观：

自定义颜色

更改数值颜色

https://api.gitscope.dev/api/badges/owner/repo.svg?color=purple

深色模式（更改标签背景）

https://api.gitscope.dev/api/badges/owner/repo.svg?labelColor=dark

可用颜色

brightgreen green yellow orange red blue cyan purple pink teal indigo gray

您也可以使用十六进制颜色码，例如 ?color=ff69b4。

# 我的超棒项目

[![构建](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg)](https://github.com/owner/repo/actions)
[![许可证: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![仓库健康](https://api.gitscope.dev/api/badges/owner/repo/health.svg)](https://gitscope.dev)
[![维护中](https://api.gitscope.dev/api/badges/owner/repo/maintained.svg)](https://gitscope.dev)
[![贡献者](https://api.gitscope.dev/api/badges/owner/repo/contributors.svg)](https://gitscope.dev)

对你超棒项目的简要描述...

→ 为你的仓库生成徽章

为什么这很重要

对于用户 / 贡献者

• 在依赖项目之前，了解它是否真的在维护中。
• 在提交问题之前，确认维护者是否响应及时。
• 找到对贡献者友好的项目。

对于维护者

• 为你的维护工作获得认可。
• 表明你的项目健康且活跃。
• 吸引重视响应迅速维护者的贡献者。

如何计算分数

徽章通过 Cloudflare 边缘网络提供，缓存时间为 15 分钟。全球典型响应时间为 < 100 ms。

常见问题

我需要注册吗？
不需要。徽章可以立即在任何公共 GitHub 仓库中使用。

徽章多久更新一次？
数据缓存 15 分钟。健康指标每小时重新计算。

这会减慢我的 README 吗？
不会。边缘缓存，全球分布，响应时间低于 100 毫秒。

立即尝试

→ 为你的仓库生成徽章

或者自行构造 URL：

https://api.gitscope.dev/api/badges/YOUR-ORG/YOUR-REPO.svg

在下面投递你的仓库 👇

在评论中留下你的仓库，我会分享你的健康评分！

构建 GitScope 以帮助开源维护者避免倦怠。徽章永久免费。完整文档请见此处.