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
開源增長駭客角色
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)、點擊分析、遙測初始化器,以及從瀏覽器發出的代理/工具/模型span的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」、「workspace」、「model registry」、「training jobs」、「datasets」。
development