Skip to content
This repository was archived by the owner on Feb 15, 2025. It is now read-only.

Commit 6fb4265

Browse files
authored
Remove template specifics
1 parent 5dd039e commit 6fb4265

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

CONTRIBUTING.md

+12-15
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
1-
# Welcome to your VS Code Extension
1+
# Contributing
22

33
## What's in the folder
44

5-
- This folder contains all of the files necessary for your extension.
6-
- `package.json` - this is the manifest file in which you declare your extension and command.
7-
- The sample plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
8-
- `src/extension.ts` - this is the main file where you will provide the implementation of your command.
9-
- The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
10-
- We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
5+
- This folder contains all of the files necessary for the extension.
6+
- `package.json` - this is the manifest file in which you declare the extension.
7+
- `src/extension.ts` - this is the main file where functionality is provided.
8+
- The file exports one function, `activate`, which is called the very first time the extension is activated.
119

1210
## Get up and running straight away
1311

14-
- Press `F5` to open a new window with your extension loaded.
15-
- Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
16-
- Set breakpoints in your code inside `src/extension.ts` to debug your extension.
17-
- Find output from your extension in the debug console.
12+
- Press `F5` to open a new window with the extension loaded.
13+
- Set breakpoints in your code inside `src/extension.ts` to debug the extension.
14+
- Find output from the extension in the debug console.
1815

1916
## Make changes
2017

2118
- You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
22-
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
19+
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with the extension to load your changes.
2320

2421
## Explore the API
2522

@@ -28,7 +25,7 @@
2825
## Run tests
2926

3027
- Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
31-
- Press `F5` to run the tests in a new window with your extension loaded.
28+
- Press `F5` to run the tests in a new window with the extension loaded.
3229
- See the output of the test result in the debug console.
3330
- Make changes to `src/test/suite/extension.test.ts` or create new test files inside the `test/suite` folder.
3431
- The provided test runner will only consider files matching the name pattern `**.test.ts`.
@@ -37,6 +34,6 @@
3734
## Go further
3835

3936
- [Follow UX guidelines](https://code.visualstudio.com/api/ux-guidelines/overview) to create extensions that seamlessly integrate with VS Code's native interface and patterns.
40-
- Reduce the extension size and improve the startup time by [bundling your extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
41-
- [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
37+
- Reduce the extension size and improve the startup time by [bundling the extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
38+
- [Publish the extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
4239
- Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).

0 commit comments

Comments
 (0)