pr-review

作者: microsoft

验证vscode-docs拉取请求在microsoft/vscode和microsoft/vscode-copilot-chat中针对VS Code源代码的技术准确性。用于……

npx skills add https://github.com/microsoft/vscode-docs --skill pr-review

PR Technical Accuracy Review

Review a vscode-docs pull request and verify every factual claim about VS Code behavior against the source code in microsoft/vscode and microsoft/vscode-copilot-chat. Produce an actionable list of findings the author can address before merging.

This skill checks technical accuracy only. It does not enforce writing style, frontmatter, or release-notes structure — use the release-note-writer or frontmatter-description skills for those.

When to Use

  • Reviewing a vscode-docs PR that documents a new or updated VS Code or Copilot feature.
  • Auditing existing docs for drift after a feature has changed.
  • Asked to "fact-check", "verify", or "validate" a docs change against the product.
  • Before merging a PR that touches docs/, api/, remote/, or release-notes content tied to a specific behavior.

Do not use this skill for pure copy-edits, redirects, image swaps, or other changes that make no factual claims.

Repos to Check

Area being documentedPrimary source repo(s)
Core editor, workbench, debug, terminal, tasks, settings, commands, keybindingsmicrosoft/vscode
Copilot Chat, inline chat, agent mode, chat tools, chat participants, MCP integration in chatmicrosoft/vscode-copilot-chat
Extension API, contribution points, package.json schemamicrosoft/vscode (under src/vs/workbench/api/, src/vscode-dts/, and extensions/)
Enterprise policiesmicrosoft/vscode (policy definitions) — note that enterprise/policies.md is generated; verify against source, not the generated file

Use the gh CLI for all GitHub interactions (see user memory gh-cli-powershell.md for PowerShell-specific patterns).

Procedure

1. Identify the PR and its diff

  • If a PR number was given, run gh pr view <number> --json number,title,headRefName,baseRefName,files,body to get metadata and the file list.
  • If no argument was given, run gh pr view --json ... to use the PR for the current branch. If there is no associated PR, fall back to git diff origin/main...HEAD.
  • Get the actual changed lines with gh pr diff <number> (or git diff for a branch).
  • Skip files whose changes are purely cosmetic (typo fixes, image renames, redirect entries, frontmatter-only edits).

2. Extract verifiable claims

Walk the diff and build a list of every claim that can be checked against source code. Include line numbers from the new file content. Categories to look for:

CategoryExamples
Settingeditor.fontSize, chat.agent.enabled, default values, allowed enum values, deprecation status
CommandCommand IDs (workbench.action.*), command palette titles, the action they perform
KeybindingDefault key bindings, when clauses, platform-specific overrides
Menu / UI labelMenu item text, button labels, view titles, walkthrough step titles
APINames, signatures, and shapes in vscode.d.ts / vscode.proposed.*.d.ts
Contribution pointpackage.json schema entries (contributes.*), required fields
Chat tool / participantTool names, participant IDs, tool input/output schemas, agent mode availability
MCPServer config schema, supported transports, capability flags
Version availability"Available since 1.X" / "New in 1.X" claims
Default behaviorWhat happens out-of-the-box, what is on/off by default
PolicyPolicy names, supported values, scope

Treat anchor-style references (e.g., setting(chat.agent.enabled), command:workbench.action.X) as claims to verify.

3. Verify each claim

For every claim, locate the source of truth and compare. Prefer one targeted lookup per claim — do not download full files when a search will do.

Search the source repos (parallelize independent lookups):

  • gh search code --repo microsoft/vscode '"<exact-string>"' for setting IDs, command IDs, contribution keys.
  • gh search code --repo microsoft/vscode-copilot-chat '"<exact-string>"' for chat tool names, participant IDs, agent-mode flags.
  • gh api "search/code?q=<query>+repo:microsoft/vscode" when the gh search CLI quotes the query in a way that breaks qualifiers (see user memory gh-cli-powershell.md).
  • gh api repos/microsoft/vscode/contents/<path>?ref=main to read a specific file.

Where things live (common starting points):

  • Settings — search for '<setting.id>' near registerConfiguration calls; default values are in the default: field of the schema.
  • Commands — search for CommandsRegistry.registerCommand or registerAction2 with the matching id.
  • Keybindings — search for KeybindingsRegistry.registerKeybindingRule or look in src/vs/workbench/browser/parts/editor/... and feature folders.
  • Extension API — src/vscode-dts/vscode.d.ts (stable) and src/vscode-dts/vscode.proposed.*.d.ts (proposed).
  • Chat tools — search microsoft/vscode-copilot-chat for displayName, toolReferenceName, or the tool ID string.
  • Contribution points — extensions/<ext>/package.json and the schema in src/vs/workbench/api/common/extHost*.ts.

Version availability — when a doc claims "since 1.X":

  • gh api repos/microsoft/vscode/contents/<file>?ref=release/1.X to see if the symbol existed in that branch, or
  • gh search commits --repo microsoft/vscode '<symbol>' to find when it was introduced.

If a claim cannot be verified after a reasonable search, mark it Unverified rather than failing it — the author may have access to context the source does not expose.

4. Categorize each finding

SeverityUse when
ErrorThe doc contradicts the source code (wrong setting name, wrong default, wrong command ID, removed API, wrong key binding).
WarningThe claim is partially correct but misleading (default changed in a recent release, behavior is platform-specific and the doc does not say so, feature is behind a setting the doc does not mention).
SuggestionOptional clarification — link to the source, add a "since 1.X" note, mention a related setting.
UnverifiedCould not locate the source of truth; ask the author to confirm.

5. Produce the findings list

Output a Markdown report with this structure:

## PR Accuracy Review: #<number> — <title>

**Files reviewed:** <count>
**Claims checked:** <count>
**Result:** <Pass | Pass with warnings | Needs changes>

### Errors

* **`<file>`:L<line>** (`<category>`) — <one-line description>
  * Doc says: `<quoted text>`
  * Source: `<repo>/<path>#L<line>` — <what the source actually says>
  * Fix: <specific suggested correction>

### Warnings

* ...

### Suggestions

* ...

### Unverified

* **`<file>`:L<line>** — <claim>. Searched <queries tried>. Please confirm.

Rules for the report:

  • Use workspace-relative paths and 1-based line numbers for vscode-docs files, formatted as Markdown links per the fileLinkification rules.
  • For source-code citations, include the repo, file path, and (when known) line or commit. A gh-friendly URL is fine: https://github.com/microsoft/vscode/blob/main/<path>#L<line>.
  • Quote the doc text exactly so the author can search for it.
  • Keep each finding to one issue — split combined problems into separate items.
  • If everything checks out, say so explicitly and skip the empty sections.

6. Summary

End with:

  • Counts by severity.
  • An overall verdict: Pass, Pass with warnings, or Needs changes (any Errors → Needs changes).
  • A reminder that this review covers technical accuracy only, and to run style/frontmatter skills separately if needed.

Notes

  • Do not push commits or post review comments on the PR unless the user explicitly asks. This skill produces a report for the user to act on.
  • Do not edit enterprise/policies.md — it is generated; flag policy issues against enterprise/policies-template.md and the source policy definitions instead.
  • When the doc references screenshots or videos, do not attempt to verify their contents — only verify any captions, labels, or alt text that make factual claims.
  • Prefer main as the source-of-truth ref unless the PR explicitly documents behavior on a release branch or Insiders-only feature, in which case check release/1.X or recent commits accordingly.

来自 microsoft 的更多技能

oss-growth
microsoft
OSS增长黑客角色
agent-framework-azure-ai-py
microsoft
使用Microsoft Agent Framework Python SDK(agent-framework-azure-ai)构建Azure AI Foundry代理。在创建使用AzureAIAgentsProvider的持久化代理、使用托管工具(代码解释器、文件搜索、网络搜索)、集成MCP服务器、管理对话线程或实现流式响应时使用。涵盖函数工具、结构化输出和多工具代理。
development
airunway-aks-setup
microsoft
在AKS上设置AI Runway——从裸集群到运行模型。涵盖集群验证、控制器安装、GPU评估、提供商设置和首次部署。适用场景:“设置AI Runway”、“接入AKS集群”、“安装AI Runway”、“airunway设置”、“将模型部署到AKS”、“在AKS上进行GPU推理”、“在AKS上配置KAITO”、“在AKS上运行LLM”、“在AKS上使用vLLM”、“在AKS上设置模型服务”、“AI Runway控制器”。
devops
appinsights-instrumentation
microsoft
使用Azure Application Insights对Web应用进行插桩的指南。提供遥测模式、SDK设置和配置参考。适用场景:如何对应用进行插桩、App Insights SDK、遥测模式、什么是App Insights、Application Insights指南、插桩示例、APM最佳实践。
devops
applicationinsights-web-ts
microsoft
使用Application Insights JavaScript SDK(@microsoft/applicationinsights-web)为浏览器/Web应用添加检测。用于真实用户监控(RUM)——页面视图、点击、AJAX/fetch依赖项、异常、自定义事件,以及与后端OpenTelemetry追踪关联的浏览器端GenAI代理追踪。涵盖SDK加载器脚本和npm设置、框架扩展(React、React Native、Angular)、点击分析、遥测初始化器,以及从浏览器发出的代理/工具/模型跨度所遵循的OTel GenAI语义约定。
devops
azure-ai-anomalydetector-java
microsoft
使用适用于 Java 的 Azure AI 异常检测器 SDK 构建异常检测应用程序。在实现单变量/多变量异常检测、时间序列分析或 AI 驱动的监控时使用。
development
azure-ai-language-conversations-py
microsoft
使用azure-ai-language-conversations Python SDK实现对话语言理解(CLU)。当使用ConversationAnalysisClient分析对话意图和实体、构建NLP功能或将语言理解集成到应用程序中时使用。
development
azure-ai-ml-py
microsoft
Azure Machine Learning SDK v2 for Python。用于机器学习工作区、作业、模型、数据集、计算资源和管道。 触发词:“azure-ai-ml”、“MLClient”、“工作区”、“模型注册表”、“训练作业”、“数据集”。
development