# shields - Doramagic AI Context Pack

> 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。

## 充分原则

- **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。
- **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。

## 给宿主 AI 的使用方式

你正在读取 Doramagic 为 shields 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。

## Claim 消费规则

- **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。
- **事实最低状态**：`supported`
- `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。
- `weak`：只能作为低置信度线索，必须要求用户继续核实。
- `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。
- `unverified`：不得作为事实使用，应明确说证据不足。
- `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。

## 它最适合谁

- **想在安装前理解开源项目价值和边界的用户**：当前证据主要来自项目文档。 证据：`README.md` Claim：`clm_0002` supported 0.86

## 它能做什么

- **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`badge-maker/README.md` Claim：`clm_0001` supported 0.86

## 怎么开始

- `npm install badge-maker` 证据：`badge-maker/README.md` Claim：`clm_0003` supported 0.86
- `npm install -g badge-maker` 证据：`badge-maker/README.md` Claim：`clm_0004` supported 0.86

## 继续前判断卡

- **当前建议**：先做角色匹配试用
- **为什么**：这个项目更像角色库，核心风险是选错角色或把角色文案当执行能力；先用 Prompt Preview 试角色匹配，再决定是否沙盒导入。

### 30 秒判断

- **现在怎么做**：先做角色匹配试用
- **最小安全下一步**：先用 Prompt Preview 试角色匹配；满意后再隔离导入
- **先别相信**：角色质量和任务匹配不能直接相信。
- **继续会触碰**：角色选择偏差、命令执行、本地环境或项目文件

### 现在可以相信

- **适合人群线索：想在安装前理解开源项目价值和边界的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0002` supported 0.86
- **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`badge-maker/README.md` Claim：`clm_0001` supported 0.86
- **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`badge-maker/README.md` Claim：`clm_0003` supported 0.86

### 现在还不能相信

- **角色质量和任务匹配不能直接相信。**（unverified）：角色库证明有很多角色，不证明每个角色都适合你的具体任务，也不证明角色能产生高质量结果。
- **不能把角色文案当成真实执行能力。**（unverified）：安装前只能判断角色描述和任务画像是否匹配，不能证明它能在宿主 AI 里完成任务。
- **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。
- **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。
- **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。
- **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。
- **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。
- **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。

### 继续会触碰什么

- **角色选择偏差**：用户对任务应该由哪个专家角色处理的判断。 原因：选错角色会让 AI 从错误专业视角回答，浪费时间或误导决策。
- **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`badge-maker/README.md`
- **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`badge-maker/README.md`
- **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。

### 最小安全下一步

- **先跑 Prompt Preview**：先用交互式试用验证任务画像和角色匹配，不要先导入整套角色库。（适用：任何项目都适用，尤其是输出质量未知时。）
- **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。）
- **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。）

### 退出方式

- **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。
- **保留原始角色选择记录**：如果输出偏题，可以回到任务画像阶段重新选择角色，而不是继续沿着错误角色推进。
- **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。
- **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。

## 哪些只能预览

- 解释项目适合谁和能做什么
- 基于项目文档演示典型对话流程
- 帮助用户判断是否值得安装或继续研究

## 哪些必须安装后验证

- 真实安装 Skill、插件或 CLI
- 执行脚本、修改本地文件或访问外部服务
- 验证真实输出质量、性能和兼容性

## 边界与风险判断卡

- **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0005` inferred 0.45
- **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`badge-maker/README.md` Claim：`clm_0006` supported 0.86
- **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。
- **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。
- **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。

## 开工前工作上下文

### 加载顺序

- 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。
- 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。
- 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。
- 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。
- 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。

### 任务路由

- **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`badge-maker/README.md` Claim：`clm_0001` supported 0.86

### 上下文规模

- 文件总数：1430
- 重要文件覆盖：40/1430
- 证据索引条目：73
- 角色 / Skill 条目：26

### 证据不足时的处理

- **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。
- **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。
- **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。
- **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。

## Prompt Recipes

### 适配判断

- 目标：判断这个项目是否适合用户当前任务。
- 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。

```text
请基于 shields 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。
```

### 安装前体验

- 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。
- 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。

```text
请把 shields 当作安装前体验资产，而不是已安装工具或真实运行环境。

请严格输出四段：
1. 先问我 3 个必要问题。
2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。
3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。
4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。

硬性边界：
- 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。
- 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。
- 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。
- 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。
- Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。
- 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。

```

### 角色 / Skill 选择

- 目标：从项目里的角色或 Skill 中挑选最匹配的资产。
- 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。

```text
请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。
```

### 风险预检

- 目标：安装或引入前识别环境、权限、规则冲突和质量风险。
- 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。

```text
请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。
```

### 宿主 AI 开工指令

- 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。
- 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。

```text
请基于 shields 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。
```

## 角色 / Skill 索引

- 共索引 26 个角色 / Skill / 项目文档条目。

- **Examples**（project_doc）：This is home to Shields.io shields.io , a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 1.6 billion images and… 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`README.md`
- **badge-maker**（project_doc）：! npm version https://img.shields.io/npm/v/badge-maker.svg https://npmjs.org/package/badge-maker ! npm license https://img.shields.io/npm/l/badge-maker.svg https://npmjs.org/package/badge-maker ! npm type definitions https://img.shields.io/npm/types/badge-maker https://npmjs.org/package/badge-maker 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`badge-maker/README.md`
- **Contributing to Shields**（project_doc）：Shields is a community project. We invite your participation through financial contributions, issues, and pull requests! 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CONTRIBUTING.md`
- **chris48s**（project_doc）：Alongside the general visual refresh and improvements to look and feel, our new frontend has allowed us to address a number of long-standing feature requests and enhancements: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2023-07-03-new-frontend.md`
- **chris48s**（project_doc）：We recently shipped a feature which allows you to pass an arbitrary filter to the GitHub tag and release badges. The filter param can be used to apply a filter to the project's tag or release names before selecting the latest from the list. Two constructs are available: is a wildcard matching zero or more characters, and if the pattern starts with a ! , the whole pattern is negated. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2023-07-29-tag-filter.md`
- **chris48s**（project_doc）：We serve a lot of badges which display information fetched from the GitHub API. When I say a lot, this varies a bit but in a typical hour we make hundreds of thousands of calls to the GitHub API. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-11-14-token-pool.md`
- **Intro**（project_doc）：Shields.io is a service for concise, consistent, and legible badges, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. It is used by some of the world's most popular open-source projects. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/docs/index.md`
- **Logos**（project_doc）：We support a wide range of logos via SimpleIcons https://simpleicons.org/ . All simple-icons are referenced using icon slugs. e.g: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/docs/logos.md`
- **Static Badges**（project_doc）：It is possible to use shields.io to make a wide variety of badges displaying static text and/or logos. For example: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/docs/static-badges.md`
- **Community**（project_doc）：Shields.io is possible thanks to the people and companies who donate money, services or time to keep the project running. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/src/pages/community.md`
- **Privacy Policy**（project_doc）：Shields.io is non-tracking and privacy-respecting. This Privacy Policy explains how we handle your data in compliance with the General Data Protection Regulation GDPR . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/src/pages/privacy.md`
- **Changelog**（project_doc）：Note: this changelog is for the shields.io server. The changelog for the badge-maker NPM package is at https://github.com/badges/shields/blob/master/badge-maker/CHANGELOG.md 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CHANGELOG.md`
- **Contributor Covenant Code of Conduct**（project_doc）：Contributor Covenant Code of Conduct 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CODE_OF_CONDUCT.md`
- **Security Policy**（project_doc）：Please follow this guidance when reporting security issues affecting: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`SECURITY.md`
- **Changelog**（project_doc）：- Drop use-strict from badge-maker header 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`badge-maker/CHANGELOG.md`
- **chris48s**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 10. This release removes 45 icons. A full list of the removals can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/10.0.0 . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2023-11-29-simpleicons10.md`
- **chris48s**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 11. This release removes the following 4 icons: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-01-13-simpleicons11.md`
- **chris48s**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 12. This release removes the following 10 icons: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-06-01-simpleicons12.md`
- **chris48s**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 13. This release removes 65 icons and renames one. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/13.0.0 . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-07-05-simpleicons13.md`
- **PyvesB**（project_doc）：Following discussions in 9476 https://github.com/badges/shields/issues/9476 , we've gone ahead and deleted all custom logos that were maintained on the Shields.io side bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis , and will solely rely on the Simple-Icons project https://github.com/simple-icons/simple-icons to provide named logos for our badges from now on. If you… 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-07-10-sunsetting-shields-custom-logos.md`
- **chris48s**（project_doc）：We've just published a critical security advisory relating to a Remote Code Execution vulnerability in Dynamic JSON/TOML/YAML badges: https://github.com/badges/shields/security/advisories/GHSA-rxvx-x284-4445 Thanks to @nickcopi https://github.com/nickcopi for his help with this. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-09-25-rce.md`
- **jNullj**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 14. This release removes 53 icons and renames 6: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2024-12-27-simpleicons14.md`
- **chris48s**（project_doc）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 15. This release removes 50 icons and renames 7. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/15.0.0 . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2025-06-06-simpleicons15.md`
- **jNullj**（project_doc）：A recent vulnerability in the eslint-config-prettier package, identified as CVE-2025-54313 https://www.endorlabs.com/learn/cve-2025-54313-eslint-config-prettier-compromise----high-severity-but-windows-only , has raised concerns about potential remote code execution RCE attacks. This vulnerability specifically affects Windows users and has been classified as high severity. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2025-07-26-CVE-2025-54313.md`
- **LitoMore**（project_doc）：Logos on Shields.io are provided by Simple Icons. We've recently upgraded to Simple Icons 16. This release removes 44 icons and renames 2. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/16.0.0 . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/blog/2025-12-03-simple-icons-16.md`
- **Donate**（project_doc）：You can donate to Shields.io via OpenCollective https://opencollective.com/shields . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`frontend/src/pages/donate.md`

## 证据索引

- 共索引 73 条证据。

- **Examples**（documentation）：This is home to Shields.io shields.io , a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 1.6 billion images and is used by some of the world's most popular open-source projects, VS Code vscode , Vue.js vue and Bootstrap bootstrap to name a few. 证据：`README.md`
- **badge-maker**（documentation）：! npm version https://img.shields.io/npm/v/badge-maker.svg https://npmjs.org/package/badge-maker ! npm license https://img.shields.io/npm/l/badge-maker.svg https://npmjs.org/package/badge-maker ! npm type definitions https://img.shields.io/npm/types/badge-maker https://npmjs.org/package/badge-maker 证据：`badge-maker/README.md`
- **Package**（package_manifest）：{ "name": "badge-maker", "version": "5.0.2", "type": "module", "exports": { ".": { "types": "./index.d.ts", "import": "./lib/index.js", "default": "./lib/index.js" } }, "description": "Shields.io badge library", "keywords": "GitHub", "badge", "SVG", "image", "shields.io" , "types": "index.d.ts", "repository": { "type": "git", "url": "git+https://github.com/badges/shields.git", "directory": "badge-maker" }, "author": "Thaddée Tyl ", "license": "CC0-1.0", "bugs": { "url": "https://github.com/badges/shields/issues" }, "homepage": "https://shields.io", "bin": { "badge": "lib/badge-cli.js" }, "engines": { "node": " =20" }, "collective": { "type": "opencollective", "url": "https://opencollective.… 证据：`badge-maker/package.json`
- **Package**（package_manifest）：{ "name": "badge-frontend", "version": "0.0.0", "description": "Shields.io frontend", "private": true, "homepage": "https://shields.io", "license": "CC0-1.0", "repository": { "type": "git", "url": "git+https://github.com/badges/shields.git", "directory": "frontend" }, "scripts": { "test": "echo 'Run tests from parent dir'; false" } } 证据：`frontend/package.json`
- **Package**（package_manifest）：{ "name": "shields.io", "version": "0.0.0", "description": "Shields.io server and frontend", "private": true, "keywords": "GitHub", "badge", "SVG", "image", "shields.io" , "homepage": "https://shields.io", "bugs": { "url": "https://github.com/badges/shields/issues" }, "license": "CC0-1.0", "author": "Thaddée Tyl ", "repository": { "type": "git", "url": "https://github.com/badges/shields" }, "dependencies": { "@renovatebot/pep440": "^5.0.0", "@renovatebot/ruby-semver": "^5.0.0", "@sentry/node-core": "^10.55.0", "@shields io/camp": "^18.1.2", "@xmldom/xmldom": "0.9.10", "badge-maker": "file:badge-maker", "byte-size": "^9.0.1", "camelcase": "^9.0.0", "chalk": "^5.6.2", "check-node-version": "^… 证据：`package.json`
- **Contributing to Shields**（documentation）：Shields is a community project. We invite your participation through financial contributions, issues, and pull requests! 证据：`CONTRIBUTING.md`
- **License**（source_file）：The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights defined below upon the creator and subsequent owner s each and all, an "owner" of an original work of authorship and/or a database each, a "Work" . 证据：`LICENSE`
- **License**（source_file）：The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights defined below upon the creator and subsequent owner s each and all, an "owner" of an original work of authorship and/or a database each, a "Work" . 证据：`badge-maker/LICENSE`
- **2023 07 03 New Frontend**（documentation）：Alongside the general visual refresh and improvements to look and feel, our new frontend has allowed us to address a number of long-standing feature requests and enhancements: 证据：`frontend/blog/2023-07-03-new-frontend.md`
- **2023 07 29 Tag Filter**（documentation）：We recently shipped a feature which allows you to pass an arbitrary filter to the GitHub tag and release badges. The filter param can be used to apply a filter to the project's tag or release names before selecting the latest from the list. Two constructs are available: is a wildcard matching zero or more characters, and if the pattern starts with a ! , the whole pattern is negated. 证据：`frontend/blog/2023-07-29-tag-filter.md`
- **2024 11 14 Token Pool**（documentation）：We serve a lot of badges which display information fetched from the GitHub API. When I say a lot, this varies a bit but in a typical hour we make hundreds of thousands of calls to the GitHub API. 证据：`frontend/blog/2024-11-14-token-pool.md`
- **Intro**（documentation）：Shields.io is a service for concise, consistent, and legible badges, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. It is used by some of the world's most popular open-source projects. 证据：`frontend/docs/index.md`
- **Logos**（documentation）：We support a wide range of logos via SimpleIcons https://simpleicons.org/ . All simple-icons are referenced using icon slugs. e.g: 证据：`frontend/docs/logos.md`
- **Static Badges**（documentation）：It is possible to use shields.io to make a wide variety of badges displaying static text and/or logos. For example: 证据：`frontend/docs/static-badges.md`
- **Community**（documentation）：Shields.io is possible thanks to the people and companies who donate money, services or time to keep the project running. 证据：`frontend/src/pages/community.md`
- **Privacy Policy**（documentation）：Shields.io is non-tracking and privacy-respecting. This Privacy Policy explains how we handle your data in compliance with the General Data Protection Regulation GDPR . 证据：`frontend/src/pages/privacy.md`
- **Server**（source_file）：integrations: integrations = { const filtered = integrations.filter integration = !disabledIntegrations.includes integration.name , if filtered.length !== integrations.length - disabledIntegrations.length 证据：`server.js`
- **Make Badge.Spec**（source_file）：async function expectBadgeToMatchSnapshot format function testColor color = '', colorAttr = 'color' 证据：`badge-maker/lib/make-badge.spec.js`
- **404**（source_file）：These aren't the pages you're looking for I have nothing to offer for this request … but blood, toil, tears and sweat. Fortunately, the main page can offer rainbows instead ! You probably landed on this page because a link was broken, because someone mistyped its URL, or because of an irrelevant mistake. Don't worry, though: there is all of the rest of the Web to explore! 证据：`core/server/error-pages/404.html`
- **500**（source_file）：A server error occurred I have nothing to offer for this request … but blood, toil, tears and sweat. And trying again later. 证据：`core/server/error-pages/500.html`
- **Prometheus Metrics**（source_file）：export default class PrometheusMetrics ⋮---- async registerMetricsEndpoint server, enabled = true stop async metrics createNumRequestCounter noteResponseTime responseTime createServiceResponseSizeHistogram noteGithubTokenInvalidation noteGithubTokenPoolMetrics tokenDebugInfo 证据：`core/server/prometheus-metrics.js`
- **Server**（source_file）：coerce: value, state, options = ⋮---- validate value, helpers ⋮---- function addHandlerAtIndex camp, index, handlerFn function isOnHeroku function isOnFly class Server ⋮---- validatePrivateConfig privateConfig, privateConfigSchema get port get baseUrl requireCloudflare registerErrorHandlers registerRedirects async registerServices bootstrapAgent / Start the HTTP server: Bootstrap Scoutcamp, Register handlers, Start listening for requests on this.baseUrl / async start ⋮---- // https://github.com/badges/shields/issues/3273 ⋮---- static resetGlobalState reset async stop 证据：`core/server/server.js`
- **Sql Token Persistence**（source_file）：export default class SqlTokenPersistence ⋮---- async initialize pool async stop async onTokenAdded token async onTokenRemoved token async noteTokenAdded token async noteTokenRemoved token 证据：`core/token-pooling/sql-token-persistence.js`
- **Token Pool**（source_file）：function sanitizeToken id function getUtcEpochSeconds class Token ⋮---- get id get data get usesRemaining get nextReset get isValid get isFrozen get hasReset get isExhausted get decrementedUsesRemaining update usesRemaining, nextReset invalidate freeze unfreeze getDebugInfo ⋮---- class TokenPool ⋮---- static compareTokens first, second add id, data, usesRemaining, nextReset nextBatch next forEach callback ⋮---- function visit item ⋮---- serializeDebugInfo 证据：`core/token-pooling/token-pool.js`
- **Homepage Features**（source_file）：function Feature export default function HomepageFeatures 证据：`frontend/src/components/homepage-features.js`
- **Github Api Provider**（source_file）：class GithubApiProvider ⋮---- addToken tokenString getTokenDebugInfo getV3RateLimitFromHeaders headers getV4RateLimitFromBody body updateToken invalidateToken token, reason tokenForUrl url async fetch requestFetcher, url, options = 证据：`services/github/github-api-provider.js`
- **Github Auth Service**（source_file）：function createRequestFetcher context class GithubAuthV3Service extends BaseJsonService class ConditionalGithubAuthV3Service extends BaseJsonService class GithubAuthV4Service extends BaseGraphqlService ⋮---- async requestGraphql attrs 证据：`services/github/github-auth-service.js`
- **Github Constellation**（source_file）：class GithubConstellation ⋮---- static createOauthHelper config ⋮---- onTokenInvalidated: tokenString ⋮---- scheduleDebugLogging scheduleMetricsCollection async initialize server, metricInstance ⋮---- onTokenAccepted: tokenString ⋮---- onTokenAdded tokenString onTokenInvalidated tokenString async stop 证据：`services/github/github-constellation.js`
- **Changelog**（documentation）：Note: this changelog is for the shields.io server. The changelog for the badge-maker NPM package is at https://github.com/badges/shields/blob/master/badge-maker/CHANGELOG.md 证据：`CHANGELOG.md`
- **Contributor Covenant Code of Conduct**（documentation）：Contributor Covenant Code of Conduct 证据：`CODE_OF_CONDUCT.md`
- **Security Policy**（documentation）：Please follow this guidance when reporting security issues affecting: 证据：`SECURITY.md`
- **Changelog**（documentation）：- Drop use-strict from badge-maker header 证据：`badge-maker/CHANGELOG.md`
- **Index**（source_file）：shields.io concise, consistent, legible 证据：`core/server/test-public/index.html`
- **2023 11 29 Simpleicons10**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 10. This release removes 45 icons. A full list of the removals can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/10.0.0 . 证据：`frontend/blog/2023-11-29-simpleicons10.md`
- **2024 01 13 Simpleicons11**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 11. This release removes the following 4 icons: 证据：`frontend/blog/2024-01-13-simpleicons11.md`
- **2024 06 01 Simpleicons12**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 12. This release removes the following 10 icons: 证据：`frontend/blog/2024-06-01-simpleicons12.md`
- **2024 07 05 Simpleicons13**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 13. This release removes 65 icons and renames one. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/13.0.0 . 证据：`frontend/blog/2024-07-05-simpleicons13.md`
- **2024 07 10 Sunsetting Shields Custom Logos**（documentation）：Following discussions in 9476 https://github.com/badges/shields/issues/9476 , we've gone ahead and deleted all custom logos that were maintained on the Shields.io side bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis , and will solely rely on the Simple-Icons project https://github.com/simple-icons/simple-icons to provide named logos for our badges from now on. If you were using a Shields custom logo, you will have transparently switched over to the corresponding Simple-Icon and do not need to make changes to your badges. 证据：`frontend/blog/2024-07-10-sunsetting-shields-custom-logos.md`
- **1. Users who have authorized the Shields.io GitHub OAuth app**（documentation）：We've just published a critical security advisory relating to a Remote Code Execution vulnerability in Dynamic JSON/TOML/YAML badges: https://github.com/badges/shields/security/advisories/GHSA-rxvx-x284-4445 Thanks to @nickcopi https://github.com/nickcopi for his help with this. 证据：`frontend/blog/2024-09-25-rce.md`
- **2024 12 27 Simpleicons14**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 14. This release removes 53 icons and renames 6: 证据：`frontend/blog/2024-12-27-simpleicons14.md`
- **2025 06 06 Simpleicons15**（documentation）：Logos on Shields.io are provided by SimpleIcons. We've recently upgraded to SimpleIcons 15. This release removes 50 icons and renames 7. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/15.0.0 . 证据：`frontend/blog/2025-06-06-simpleicons15.md`
- **2025 07 26 Cve 2025 54313**（documentation）：A recent vulnerability in the eslint-config-prettier package, identified as CVE-2025-54313 https://www.endorlabs.com/learn/cve-2025-54313-eslint-config-prettier-compromise----high-severity-but-windows-only , has raised concerns about potential remote code execution RCE attacks. This vulnerability specifically affects Windows users and has been classified as high severity. 证据：`frontend/blog/2025-07-26-CVE-2025-54313.md`
- **2025 12 03 Simple Icons 16**（documentation）：Logos on Shields.io are provided by Simple Icons. We've recently upgraded to Simple Icons 16. This release removes 44 icons and renames 2. A full list of the changes can be found in the release notes https://github.com/simple-icons/simple-icons/releases/tag/16.0.0 . 证据：`frontend/blog/2025-12-03-simple-icons-16.md`
- **Donate**（documentation）：You can donate to Shields.io via OpenCollective https://opencollective.com/shields . 证据：`frontend/src/pages/donate.md`
- **.C8Rc**（structured_config）：{ "reporter": "lcov" , "all": true, "silent": true, "clean": false, "exclude": " / .spec.js", " / .integration.js", " /test-helpers.js", " / -test-helpers.js", " / -fixtures.js", " / .test-d.ts", "dangerfile.js", "core/service-test-runner", "core/got-test-client.js", "services/ / .tester.js", "services/test-validators.js", "services/tester.js", "core/base-service/loader-test-fixtures", "scripts", "coverage", ".github", " /public/", "cypress", "frontend", "migrations" } 证据：`.c8rc.json`
- **Devcontainer**（structured_config）：{ "name": "Node.js", // "Officially" maintained node devcontainer image from Microsoft // https://github.com/devcontainers/templates/tree/main/src/javascript-node "image": "mcr.microsoft.com/devcontainers/javascript-node:1-22-bookworm", 证据：`.devcontainer/devcontainer.json`
- **Jsdoc**（structured_config）：{ "source": { "exclude": " snapshots ", "coverage", "node modules", "public" , "excludePattern": ".+\\. service spec tester \\.js$" }, "plugins": "plugins/markdown" , "opts": { "destination": "api-docs/", "readme": "README.md", "recurse": true, "tutorials": "doc/" } } 证据：`jsdoc.json`
- **Improve layer cacheability.**（source_file）：node modules/ .git/ .gitignore .github .vscode/ fly.toml 证据：`.dockerignore`
- **The formatting for most files is handled by Prettier nowadays.**（source_file）：The formatting for most files is handled by Prettier nowadays. See https://github.com/badges/shields/blob/master/CONTRIBUTING.md prettier for more information. 证据：`.editorconfig`
- **.gitattributes**（source_file）：text=auto eol=lf 证据：`.gitattributes`
- **Folder view configuration files**（source_file）：Folder view configuration files .DS Store Desktop.ini 证据：`.gitignore`
- **.node-version**（source_file）：22 证据：`.node-version`
- **.npmrc**（source_file）：engine-strict=true strict-peer-deps=true 证据：`.npmrc`
- **.prettierignore**（source_file）：package-lock.json / snapshots /api-docs public /coverage frontend/.docusaurus frontend/categories 证据：`.prettierignore`
- **.Prettierrc**（source_file）：semi: false singleQuote: true bracketSpacing: true endOfLine: lf arrowParens: avoid proseWrap: never 证据：`.prettierrc.yml`
- **Without the badge-maker package.json and CLI script in place, npm ci will fail.**（source_file）：RUN mkdir -p /usr/src/app RUN mkdir /usr/src/app/private WORKDIR /usr/src/app 证据：`Dockerfile`
- **Procfile**（source_file）：web: npm run start:server:prod 证据：`Procfile`
- **badge-maker/.npmignore**（source_file）：lib/make-badge-test-helpers.js lib/ / .spec.js index.test-d.ts 证据：`badge-maker/.npmignore`
- **Index.D**（source_file）：interface Format { label?: string message: string labelColor?: string color?: string style?: 'plastic' 'flat' 'flat-square' 'for-the-badge' 'social' logoBase64?: string links?: Array idSuffix?: string } export declare class ValidationError extends Error export declare function makeBadge format: Format : string 证据：`badge-maker/index.d.ts`
- **Index.Test D**（source_file）：import { expectType, expectError, expectAssignable } from 'tsd' import { makeBadge, ValidationError } from '.' 证据：`badge-maker/index.test-d.ts`
- 其余 13 条证据见 `AI_CONTEXT_PACK.json` 或 `EVIDENCE_INDEX.json`。

## 宿主 AI 必须遵守的规则

- **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`README.md`, `badge-maker/README.md`, `badge-maker/package.json`
- **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`README.md`, `badge-maker/README.md`, `badge-maker/package.json`

## 用户开工前应该回答的问题

- 你准备在哪个宿主 AI 或本地环境中使用它？
- 你只是想先体验工作流，还是准备真实安装？
- 你最在意的是安装成本、输出质量、还是和现有规则的冲突？

## 验收标准

- 所有能力声明都能回指到 evidence_refs 中的文件路径。
- AI_CONTEXT_PACK.md 没有把预览包装成真实运行。
- 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。

---

## Doramagic Context Augmentation

下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。

## Human Manual 骨架

使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。

宿主 AI 硬性规则：
- 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。
- 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。
- 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。

- **shields.io 系统概览与架构**：importance `high`
  - source_paths: server.js, core/base-service/base.js, core/base-service/loader.js, core/server/server.js, core/base-service/legacy-request-handler.js
- **GitHub 服务与 Token Pool 管理**：importance `high`
  - source_paths: services/github/github-api-provider.js, services/github/github-auth-service.js, services/github/github-constellation.js, core/token-pooling/token-pool.js, core/token-pooling/sql-token-persistence.js
- **徽章服务开发与扩展**：importance `high`
  - source_paths: doc/TUTORIAL.md, core/base-service/base-json.js, core/base-service/base-xml.js, core/base-service/base-yaml.js, core/base-service/base-static.js
- **部署、自托管与故障排查**：importance `high`
  - source_paths: doc/self-hosting.md, doc/production-hosting.md, doc/server-secrets.md, config/default.yml, config/production.yml

## Repo Inspection Evidence / 源码检查证据

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `dffd223ef4c0026c786c8e0d5cd93f9cc24bec55`
- inspected_files: `Dockerfile`, `README.md`, `package.json`

宿主 AI 硬性规则：
- 没有 repo_clone_verified=true 时，不得声称已经读过源码。
- 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。
- 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。

## Doramagic Pitfall Constraints / 踩坑约束

这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。

### Constraint 1: 来源证据：WinGet Service: add ReleaseDate

- Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：WinGet Service: add ReleaseDate
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/11285 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 2: 来源证据：Badge request: GitHub Discussions

- Trigger: GitHub 社区证据显示该项目存在一个能力理解相关的待验证问题：Badge request: GitHub Discussions
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/6047 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 3: 来源证据：Add a way to manually clear cached badge responses

- Trigger: GitHub 社区证据显示该项目存在一个运行相关的待验证问题：Add a way to manually clear cached badge responses
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/11877 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 4: 来源证据：Figma Community Plugins badges

- Trigger: GitHub 社区证据显示该项目存在一个维护/版本相关的待验证问题：Figma Community Plugins badges
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/11925 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 5: 来源证据：Mozilla Thunderbird add-ons (ATN)

- Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Mozilla Thunderbird add-ons (ATN)
- Why it matters: 可能影响授权、密钥配置或安全边界。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/6994 | 来源讨论提到 api key 相关条件，需在安装/试用前复核。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 6: 来源证据：Unexpectedly Rapid GitHub Token Rate Limit Depletion

- Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Unexpectedly Rapid GitHub Token Rate Limit Depletion
- Why it matters: 可能影响授权、密钥配置或安全边界。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/11912 | 来源讨论提到 node 相关条件，需在安装/试用前复核。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 7: 仓库名和安装名不一致

- Trigger: 仓库名 `shields` 与安装入口 `badge-maker` 不完全一致。
- Host AI rule: 在 npm/PyPI/GitHub 上确认包名映射和官方 README 说明。
- Why it matters: 用户照着仓库名搜索包或照着包名找仓库时容易走错入口。
- Evidence: identity.distribution | github_repo:7910045 | https://github.com/badges/shields | repo=shields; install=badge-maker
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 8: 来源证据：GitHub org not verified

- Trigger: GitHub 社区证据显示该项目存在一个配置相关的待验证问题：GitHub org not verified
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/badges/shields/issues/11917 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 9: 能力判断依赖假设

- Trigger: README/documentation is current enough for a first validation pass.
- Host AI rule: 将假设转成下游验证清单。
- Why it matters: 假设不成立时，用户拿不到承诺的能力。
- Evidence: capability.assumptions | github_repo:7910045 | https://github.com/badges/shields | README/documentation is current enough for a first validation pass.
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 10: 维护活跃度未知

- Trigger: 未记录 last_activity_observed。
- Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。
- Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。
- Evidence: evidence.maintainer_signals | github_repo:7910045 | https://github.com/badges/shields | last_activity_observed missing
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。
