Skip to content

Commit

Permalink
Remove template specifics
Browse files Browse the repository at this point in the history
  • Loading branch information
carlthome authored Sep 17, 2023
1 parent 5dd039e commit 6fb4265
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
# Welcome to your VS Code Extension
# Contributing

## What's in the folder

- This folder contains all of the files necessary for your extension.
- `package.json` - this is the manifest file in which you declare your extension and command.
- 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.
- `src/extension.ts` - this is the main file where you will provide the implementation of your command.
- 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`.
- We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
- This folder contains all of the files necessary for the extension.
- `package.json` - this is the manifest file in which you declare the extension.
- `src/extension.ts` - this is the main file where functionality is provided.
- The file exports one function, `activate`, which is called the very first time the extension is activated.

## Get up and running straight away

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

## Make changes

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

## Explore the API

Expand All @@ -28,7 +25,7 @@
## Run tests

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

- [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.
- Reduce the extension size and improve the startup time by [bundling your extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
- [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
- Reduce the extension size and improve the startup time by [bundling the extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
- [Publish the extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
- Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).

0 comments on commit 6fb4265

Please sign in to comment.