Skip to content

Commit 5d94bd4

Browse files
committed
Merge branch 'main' into vnext
2 parents 5eb7786 + 3fd46b3 commit 5d94bd4

File tree

1,883 files changed

+43575
-17404
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,883 files changed

+43575
-17404
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## DO NOT MODIFY THIS FILE MANUALLY. This is part of auto-baselining from 1ES Pipeline Templates. Go to [https://aka.ms/1espt-autobaselining] for more details.
2+
3+
pipelines:
4+
239:
5+
retail:
6+
source:
7+
credscan:
8+
lastModifiedDate: 2024-10-11
9+
eslint:
10+
lastModifiedDate: 2024-10-11
11+
psscriptanalyzer:
12+
lastModifiedDate: 2024-10-11
13+
armory:
14+
lastModifiedDate: 2024-10-11
15+
accessibilityinsights:
16+
lastModifiedDate: 2025-06-03
17+
binary:
18+
credscan:
19+
lastModifiedDate: 2024-10-11
20+
binskim:
21+
lastModifiedDate: 2025-01-09
22+
spotbugs:
23+
lastModifiedDate: 2024-10-11
24+
237:
25+
retail:
26+
source:
27+
credscan:
28+
lastModifiedDate: 2025-08-05
29+
eslint:
30+
lastModifiedDate: 2025-08-05
31+
psscriptanalyzer:
32+
lastModifiedDate: 2025-08-05
33+
armory:
34+
lastModifiedDate: 2025-08-05
35+
accessibilityinsights:
36+
lastModifiedDate: 2025-08-05
37+
binary:
38+
credscan:
39+
lastModifiedDate: 2025-08-05
40+
binskim:
41+
lastModifiedDate: 2025-08-05
42+
spotbugs:
43+
lastModifiedDate: 2025-08-05

.config/guardian/.gdnbaselines

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"properties": {
3+
"helpUri": "https://eng.ms/docs/microsoft-security/security/azure-security/cloudai-security-fundamentals-engineering/security-integration/guardian-wiki/microsoft-guardian/general/baselines"
4+
},
5+
"version": "1.0.0",
6+
"baselines": {
7+
"default": {
8+
"name": "default",
9+
"createdDate": "2025-08-05 08:36:03Z",
10+
"lastUpdatedDate": "2025-08-05 08:36:03Z"
11+
}
12+
},
13+
"results": {
14+
"a25577ddc699e709832bc436bbe266a47aa2e7fd72110237d621acaa8a858ec0": {
15+
"signature": "a25577ddc699e709832bc436bbe266a47aa2e7fd72110237d621acaa8a858ec0",
16+
"alternativeSignatures": [],
17+
"target": ".git/lfs/logs/20250805T083310.2996896.log",
18+
"line": 78,
19+
"memberOf": [
20+
"default"
21+
],
22+
"tool": "credscan",
23+
"ruleId": "CSCAN-GENERAL0120",
24+
"createdDate": "2025-08-05 08:36:03Z",
25+
"expirationDate": "2026-01-22 08:42:50Z",
26+
"justification": "This error is baselined with an expiration date of 180 days from 2025-08-05 08:42:50Z"
27+
}
28+
}
29+
}

.gitattributes

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
*.jpg filter=lfs diff=lfs merge=lfs -text
55
*.png filter=lfs diff=lfs merge=lfs -text
66
*.md diff=markdown
7-
87
# Fine-tune GitHub's language detection
98
docs/** -linguist-documentation
109
*.md linguist-detectable
10+
/workspaces/vscode-docs/docs/copilot/images/overview/configure-completions.png filter=lfs diff=lfs merge=lfs -text
11+
/workspaces/vscode-docs/docs/copilot/images/overview/change-completions-model.png filter=lfs diff=lfs merge=lfs -text

.github/copilot-instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# VS Code Docs Writing Guidelines
2+
3+
Follow the [documentation writing guidelines](../instructions/docs-writing.instructions.md) when reviewing or writing documentation.
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
applyTo: '**/*.md'
3+
---
4+
# Documentation Writing Instructions
5+
6+
These are our documentation writing style guidelines.
7+
8+
## General Style tips
9+
10+
* Get to the point fast.
11+
* Talk like a person.
12+
* Simpler is better.
13+
* Be brief. Give customers just enough information to make decisions confidently. Prune every excess word.
14+
15+
## Grammar
16+
17+
* Use present tense verbs (is, open) instead of past tense (was, opened).
18+
* Write factual statements and direct commands. Avoid hypotheticals like "could" or "would".
19+
* Use active voice where the subject performs the action.
20+
* Write in second person (you) to speak directly to readers.
21+
* Use gender-neutral language.
22+
* Avoid multiple -ing words that can create ambiguity.
23+
* Keep prepositional phrases simple and clear.
24+
* Place modifiers close to what they modify.
25+
26+
## Capitalization
27+
28+
* Use sentence-style capitalization for everything except proper nouns.
29+
* Always capitalize proper nouns.
30+
* Don’t capitalize the spelled-out form of an acronym unless it's a proper noun.
31+
* Use title-style capitalization for product and service names.
32+
* In programming languages, follow the traditional capitalization of keywords and other special terms.
33+
* Don't use all uppercase for emphasis.
34+
35+
## Numbers
36+
37+
* Spell out numbers for zero through nine, unless space is limited. Use numerals for 10 and above.
38+
* Spell out numbers at the beginning of a sentence.
39+
* Spell out ordinal numbers such as first, second, and third. Don't add -ly to form adverbs from ordinal numbers.
40+
41+
## Punctuation
42+
43+
* Use short, simple sentences.
44+
* End all sentences with a period.
45+
* Use one space after punctuation marks.
46+
* After a colon, capitalize only proper nouns.
47+
* Avoid semicolons - use separate sentences instead.
48+
* Use question marks sparingly.
49+
* Don't use slashes (/) - use "or" instead.
50+
51+
## Text formatting
52+
53+
* UI elements, like menu items, dialog names, and names of text boxes, should be in bold text.
54+
* Use code style for:
55+
* Code elements, like method names, property names, and language keywords.
56+
* SQL commands.
57+
* NuGet package names.
58+
* Command-line commands.
59+
* Database table and column names.
60+
* Resource names (like virtual machine names) that shouldn't be localized.
61+
* URLs that you don't want to be selectable.
62+
* For code placeholders, if you want users to replace part of an input string with their own values, use angle brackets (less than < and greater than > characters) on that placeholder text.
63+
* Don't apply an inline style like italic, bold, or inline code style to headings.
64+
65+
## Alerts
66+
67+
* Alerts are a Markdown extension to create block quotes that render with colors and icons that indicate the significance of the content. The following alert types are supported:
68+
69+
* `[!NOTE]` Information the user should notice even if skimming.
70+
* `[!TIP]` Optional information to help a user be more successful.
71+
* `[!IMPORTANT]` Essential information required for user success.
72+
* `[!CAUTION]` Negative potential consequences of an action.
73+
* `[!WARNING]` Dangerous certain consequences of an action.
74+
75+
## Links
76+
77+
* Links to other documentation articles should be relative, not absolute. Start relative links with `/docs/` and include the `.md` suffix.
78+
* Links in release notes should be full URLs, not relative. Use the `https://code.visualstudio.com/docs/` domain.
79+
* Links to bookmarks within the same article should be relative and start with `#`.
80+
* Link descriptions should be descriptive and make sense on their own. Don't use "click here" or "this link" or "here".
81+
82+
## Images
83+
84+
* Use images only when they add value.
85+
* Images have a descriptive and meaningful alt text that starts with "Screenshot showing" and ends with ".".
86+
* Videos have a descriptive and meaningful alt text or title that starts with "Video showing" and ends with ".".
87+
88+
## Numbered steps
89+
90+
* Write complete sentences with capitalization and periods
91+
* Use imperative verbs
92+
* Clearly indicate where actions take place (UI location)
93+
* For single steps, use a bullet instead of a number
94+
* When allowed, use angle brackets for menu sequences (File > Open)
95+
96+
## Terminology
97+
98+
* Use "Select" instead of "Click" for UI elements like buttons, menu items, links, dropdowns, and checkboxes.
99+
* Use "might" instead of "may" for conditional statements.
100+
* Avoid latin abbreviations like "e.g.". Use "for example" instead.
101+
* Use the verb "to enable" instead "to allow" unless you're referring to permissions.
102+
* Follow the terms and capitalization guidelines in #fetch [VS Code docs wiki](https://github.com/microsoft/vscode-docs/wiki/VS-Code-glossary)
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# VS Code Release Notes Writing Guide
2+
3+
## Introduction
4+
5+
You are a technical writer assistant tasked with generating release notes for all requested VS Code features.
6+
7+
## Key Principles
8+
9+
1. Identifying the Release Notes file to write to:
10+
- Use `getCurrentMilestone` tool to identify the current milestone name.
11+
- Search for the release notes file under `release-notes` folder. Please note that the file name is not same as the milestone name. So you need to do full text search to find the file. The release notes file for give milestone will contain following text: `TOCTitle:` followed by the milestone name. Example text in the file: `TOCTitle: April 2016`.
12+
- If the file does not exist, create a new file with appropriate file name.
13+
14+
2. Identifying Features to Document:
15+
- Use `getCurrentMilestone` tool to identify the current milestone.
16+
- Use the `getReleaseFeatures` tool to retrieve all features and all of them must be documented.
17+
- Each feature includes a `labels` property, which lists all labels associated with it.
18+
- A feature is identified by one of the following labels:
19+
- `feature-request`: Represents a standard feature request issue. Its description and comments contain detailed information about the feature.
20+
- `testplan-item`: Represents a structured testing plan for the feature. Its description contains in-depth details about the feature and set up and steps to test it.
21+
- Each feature also includes a `related` property, which lists related issues that provide additional context or details about the feature.
22+
- Generate release notes for all features.
23+
24+
3. Feature Section Structure:
25+
- To create a complete feature section, gather and analyze all relevant details from the following:
26+
- The summary, description, and comments of the feature itself.
27+
- If there are any related issues, the summary, description, and comments from all related issues.
28+
- Each feature section should provide a comprehensive and user-focused overview.
29+
- The title and description should not include anything related to testing, such as setup, test instructions, or validation steps.
30+
- Feature Title
31+
- Use a concise, descriptive title that clearly identifies the feature itself
32+
- Do not the take the title from the test plan item feature because it is meant for testing.
33+
- Feature Description
34+
- Provide a comprehensive explanation of the feature and its purpose.
35+
- Should include all additional and relevant information
36+
- Should include all constraints those users should be aware of.
37+
- Clearly state if the feature is in Preview or Experimental, if applicable.
38+
- Do not add Feature Description Header
39+
40+
## Important Guidelines
41+
42+
1. Settings and Commands:
43+
- Only document settings that actually exist in VS Code
44+
- Verify all setting names and values before documenting
45+
- Double-check command IDs before referencing them
46+
- Use the search tools to confirm setting/command existence
47+
48+
1. Quality Control:
49+
- Save changes using provided tools
50+
- Verify all links and references
51+
- Ensure consistency with existing docs
52+
- Fact-check all technical details
53+
54+
1. Write to release notes
55+
- Write ONLY the feature documentation sections
56+
- DO NOT include version headers, welcome messages, or update summaries
57+
- Start directly with ### feature headings
58+
- Use the write tools to write to the release notes
59+
- Do not ask for user confirmation
60+
61+
## Writing Guidelines
62+
63+
Apply these specific guidelines to all release notes. For other text, follow the general [writing guidelines](../copilot-instructions.md).
64+
65+
### Headings
66+
67+
- Don't apply an inline style like italic, bold, or inline code style to headings.
68+
- Lowercase everything except the first word in a heading.
69+
70+
### Links
71+
72+
- Links to other documentation articles should be absolute, not relative. Start absolute links with `https://code.visualstudio.com/docs/` and don't include the `.md` suffix.
73+
- Link text should be descriptive and clearly indicate the content of the linked article. Don't use "click here" or "this link" or "here".
74+
75+
### Text Formatting
76+
77+
- Notes and tips are formatted as block quotes with the word "Note" or "Tip" in bold at the start of the line. Don't use alert-style formatting for these.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
mode: 'agent'
3+
tools: ['changes', 'codebase', 'editFiles', 'extensions', 'fetch', 'findTestFiles', 'githubRepo', 'new', 'openSimpleBrowser', 'problems', 'readCellOutput', 'runCommands', 'runNotebooks', 'runTasks', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'terminalSelection', 'testFailure', 'updateUserPreferences', 'usages', 'vscodeAPI', 'Figma', 'getCurrentMilestone', 'getReleaseFeatures']
4+
---
5+
Generate release notes for the features I worked in the current release and update them in the release notes file. Use [release notes writing instructions file](../instructions/release-notes-writing.instructions.md) as a guide.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
mode: agent
3+
tools: ['codebase', 'vscodeAPI', 'problems', 'fetch', 'search']
4+
description: You are a technical writer reviewing an article for clarity, conciseness, and adherence to the documentation writing style guidelines.
5+
---
6+
Review the article for clarity, conciseness, and adherence to our documentation [writing style guidelines](../instructions/docs-writing.instructions.md).
7+
8+
Provide concrete and practical suggestions for improvement.
9+
10+
Provide your feedback in the form of a Markdown task list, with each task starting with `- [ ]`.

.husky/post-checkout

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
2+
command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
33
git lfs post-checkout "$@"

.husky/post-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
2+
command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
33
git lfs post-commit "$@"

0 commit comments

Comments
 (0)