vscode coding-guidelines.instructions.md

Coding rules for the VS Code project, covering names, formatting, types, comments, and code quality.

In plain words
What is it for?
Use it when writing or reviewing VS Code code, especially TypeScript functions, classes, interfaces, and variables.
Why use it?
It helps code changes match the project’s existing style and avoids unnecessary exports, global names, or hard-to-maintain comments.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/microsoft/vscode/coding-guidelines
Clone the repo
git clone --depth 1 https://github.com/microsoft/vscode

Made for: GitHub Copilot.

Per session 916 This file is loaded in full into every session.
When invoked 916 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00916 $0.00916
Opus 5 $0.00458 $0.00458
Sonnet 5 $0.00183 $0.00183
Haiku 4.5 $0.00092 $0.00092

Measured yesterday against content hash 0cd79cd3affd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

vscode coding-guidelines.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/coding-guidelines.instructions.md · 70 lines

How it starts

The opening of the file, as written. The whole thing — 70 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Coding Guidelines

Canonical reference: https://github.com/microsoft/vscode/wiki/Coding-Guidelines

Also see the Source Code Organization wiki page.

Indentation

Use tabs, not spaces.

Naming

  • PascalCase for types and enum values
  • camelCase for functions, methods, properties, and local variables
  • Use whole words when possible

Types

  • Do not export types or functions unless shared across multiple components
  • Do not introduce new types or values to the global namespace

Comments

  • Use JSDoc style comments for functions, interfaces, enums, and classes
  • Do not write large comments in the middle of a method or comments that explain a single line. If a line or block needs a paragraph of explanation to be understood, treat that as a signal that the code itself is unclear: extract a well-named function, introduce an explanatory variable, or simplify the logic instead. Keep any remaining inline comment to a brief note.
  • Default to NO comment. Add one only when the code cannot be made self-explanatory by naming. Code that is obvious from its identifiers must not be commented.
  • Hard limits (treat as rules, not suggestions):
    • JSDoc on a function/interface/property: at most 1–2 short sentences. Do not enumerate every branch/feature, restate the signature, list what it does NOT do, or explain parameters that are obvious from their names/types.
    • Inline comment inside a method body: at most 1 line, and only for a genuine workaround/hack, a non-obvious ordering constraint, or a surprising side effect. Never narrate the next statement (e.g. // Expand the variable, // loop over args).
  • Before writing any comment longer than one line, stop and either delete it or shorten it to a single line. A multi-line block comment inside a method body is almost always wrong.

Strings

  • "double quotes" for user-visible strings that need localization
  • 'single quotes' for everything else
  • All user-visible strings must be externalized via nls.localize() — no string concatenation, use {0} placeholders

Read the full file on GitHub · 70 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 70 lines · 916 tokens per session scan A 0cd79cd3affd

Subscribe to this mod's changes

vscode coding-guidelines.instructions.md is an instructions file published in the GitHub repository microsoft/vscode (190,061 stars, last pushed yesterday), licensed MIT. It adds 916 tokens to every session, about $0.0046 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.