Skip to content

Commit 75cda75

Browse files
ramya-rao-aramya-rao-a
committed
Move how to contribute to a separate file for built in extensions microsoft#54098 
1 parent 22ec71a commit 75cda75

6 files changed

Lines changed: 89 additions & 86 deletions

File tree

‎extensions/css-language-features/CONTRIBUTING.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
## Setup
3+
4+
- Clone [Microsoft/vscode](https://github.com/microsoft/vscode)
5+
- Run `yarn` at `/`, this will install
6+
- Dependencies for `/extension/css-language-features/`
7+
- Dependencies for `/extension/css-language-features/server/`
8+
- devDependencies such as `gulp`
9+
- Open `/extensions/css-language-features/` as the workspace in VS Code
10+
- Run the [`Launch Extension`](https://github.com/Microsoft/vscode/blob/master/extensions/css-language-features/.vscode/launch.json) debug target in the Debug View. This will:
11+
- Launch the `preLaunchTask` task to compile the extension
12+
- Launch a new VS Code instance with the `css-language-features` extension loaded
13+
- You should see a notification saying the development version of `css-language-features` overwrites the bundled version of `css-language-features`
14+
- Test the behavior of this extension by editing CSS/SCSS/Less files
15+
- Run `Reload Window` command in the launched instance to reload the extension
16+
17+
### Contribute to vscode-css-languageservice
18+
19+
[Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice) contains the language smarts for CSS/SCSS/Less.
20+
This extension wraps the css language service into a Language Server for VS Code.
21+
If you want to fix CSS/SCSS/Less issues or make improvements, you should make changes at [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice).
22+
23+
However, within this extension, you can run a development version of `vscode-css-languageservice` to debug code or test language features interactively:
24+
25+
#### Linking `vscode-css-languageservice` in `css-language-features/server/`
26+
27+
- Clone [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice)
28+
- Run `yarn` in `vscode-css-languageservice`
29+
- Run `yarn link` in `vscode-css-languageservice`. This will compile and link `vscode-css-languageservice`
30+
- In `css-language-features/server/`, run `npm link vscode-css-languageservice`
31+
32+
#### Testing the development version of `vscode-css-languageservice`
33+
34+
- Open both `vscode-css-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature
35+
- Run `yarn watch` at `css-languagefeatures/server/` to recompile this extension with the linked version of `vscode-css-languageservice`
36+
- Make some changes in `vscode-css-languageservice`
37+
- Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-css-languageservice`. You can interactively test the language features.
38+
- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-css-languageservice` and `css-language-features/server/`

‎extensions/css-language-features/README.md‎

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,3 @@ This extension provides rich language support to CSS/SCSS/LESS files.
1111
- extra information on hover
1212
- navigation to definition and references
1313

14-
## Development
15-
16-
- Clone [Microsoft/vscode](https://github.com/microsoft/vscode)
17-
- Run `yarn` at `/`, this will install
18-
- Dependencies for `/extension/css-language-features/`
19-
- Dependencies for `/extension/css-language-features/server/`
20-
- devDependencies such as `gulp`
21-
- Open `/extensions/css-language-features/` as the workspace in VS Code
22-
- Run the [`Launch Extension`](https://github.com/Microsoft/vscode/blob/master/extensions/css-language-features/.vscode/launch.json) debug target in the Debug View. This will:
23-
- Launch the `preLaunchTask` task to compile the extension
24-
- Launch a new VS Code instance with the `css-language-features` extension loaded
25-
- You should see a notification saying the development version of `css-language-features` overwrites the bundled version of `css-language-features`
26-
- Test the behavior of this extension by editing CSS/SCSS/Less files
27-
- Run `Reload Window` command in the launched instance to reload the extension
28-
29-
### Contribute to vscode-css-languageservice
30-
31-
[Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice) contains the language smarts for CSS/SCSS/Less.
32-
This extension wraps the css language service into a Language Server for VS Code.
33-
If you want to fix CSS/SCSS/Less issues or make improvements, you should make changes at [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice).
34-
35-
However, within this extension, you can run a development version of `vscode-css-languageservice` to debug code or test language features interactively:
36-
37-
#### Linking `vscode-css-languageservice` in `css-language-features/server/`
38-
39-
- Clone [Microsoft/vscode-css-languageservice](https://github.com/Microsoft/vscode-css-languageservice)
40-
- Run `yarn` in `vscode-css-languageservice`
41-
- Run `yarn link` in `vscode-css-languageservice`. This will compile and link `vscode-css-languageservice`
42-
- In `css-language-features/server/`, run `npm link vscode-css-languageservice`
43-
44-
#### Testing the development version of `vscode-css-languageservice`
45-
46-
- Open both `vscode-css-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature
47-
- Run `yarn watch` at `css-languagefeatures/server/` to recompile this extension with the linked version of `vscode-css-languageservice`
48-
- Make some changes in `vscode-css-languageservice`
49-
- Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-css-languageservice`. You can interactively test the language features.
50-
- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-css-languageservice` and `css-language-features/server/`

‎extensions/emmet/CONTRIBUTING.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## How to build and run from source?
2+
3+
Read the basics about extension authoring from [Extending Visual Studio Code](https://code.visualstudio.com/docs/extensions/overview)
4+
5+
- Read [Build and Run VS Code from Source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source) to get a local dev set up running for VS Code
6+
- Open the `extensions/emmet` folder in the vscode repo in VS Code
7+
- Press F5 to start debugging
8+
9+
## Running tests
10+
11+
Tests for Emmet extension are run as integration tests as part of VS Code.
12+
13+
- Read [Build and Run VS Code from Source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source) to get a local dev set up running for VS Code
14+
- Run `./scripts/test-integration.sh` to run all the integrations tests that include the Emmet tests.

‎extensions/emmet/README.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,7 @@
66

77
See [Emmet in Visual Studio Code](https://code.visualstudio.com/docs/editor/emmet)
88

9-
## How to build and run from source?
109

11-
Read the basics about extension authoring from [Extending Visual Studio Code](https://code.visualstudio.com/docs/extensions/overview)
12-
13-
- Read [Build and Run VS Code from Source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source) to get a local dev set up running for VS Code
14-
- Open the `extensions/emmet` folder in the vscode repo in VS Code
15-
- Press F5 to start debugging
16-
17-
## Running tests
18-
19-
Tests for Emmet extension are run as integration tests as part of VS Code.
20-
21-
- Read [Build and Run VS Code from Source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source) to get a local dev set up running for VS Code
22-
- Run `./scripts/test-integration.sh` to run all the integrations tests that include the Emmet tests.
2310

2411

2512

‎extensions/html-language-features/CONTRIBUTING.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Setup
2+
3+
- Clone [Microsoft/vscode](https://github.com/microsoft/vscode)
4+
- Run `yarn` at `/`, this will install
5+
- Dependencies for `/extension/html-language-features/`
6+
- Dependencies for `/extension/html-language-features/server/`
7+
- devDependencies such as `gulp`
8+
- Open `/extensions/html-language-features/` as the workspace in VS Code
9+
- Run the [`Launch Extension`](https://github.com/Microsoft/vscode/blob/master/extensions/html-language-features/.vscode/launch.json) debug target in the Debug View. This will:
10+
- Launch the `preLaunchTask` task to compile the extension
11+
- Launch a new VS Code instance with the `html-language-features` extension loaded
12+
- You should see a notification saying the development version of `html-language-features` overwrites the bundled version of `html-language-features`
13+
- Test the behavior of this extension by editing html files
14+
- Run `Reload Window` command in the launched instance to reload the extension
15+
16+
### Contribute to vscode-html-languageservice
17+
18+
[Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice) contains the language smarts for html.
19+
This extension wraps the html language service into a Language Server for VS Code.
20+
If you want to fix html issues or make improvements, you should make changes at [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice).
21+
22+
However, within this extension, you can run a development version of `vscode-html-languageservice` to debug code or test language features interactively:
23+
24+
#### Linking `vscode-html-languageservice` in `html-language-features/server/`
25+
26+
- Clone [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice)
27+
- Run `yarn` in `vscode-html-languageservice`
28+
- Run `yarn link` in `vscode-html-languageservice`. This will compile and link `vscode-html-languageservice`
29+
- In `html-language-features/server/`, run `npm link vscode-html-languageservice`
30+
31+
#### Testing the development version of `vscode-html-languageservice`
32+
33+
- Open both `vscode-html-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature
34+
- Run `yarn watch` at `html-languagefeatures/server/` to recompile this extension with the linked version of `vscode-html-languageservice`
35+
- Make some changes in `vscode-html-languageservice`
36+
- Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-html-languageservice`. You can interactively test the language features.
37+
- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-html-languageservice` and `html-language-features/server/`

‎extensions/html-language-features/README.md‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,4 @@ This extension provides rich language support to HTML files.
1212
- navigation to definition and references
1313
- formatting
1414

15-
## Development
1615

17-
- Clone [Microsoft/vscode](https://github.com/microsoft/vscode)
18-
- Run `yarn` at `/`, this will install
19-
- Dependencies for `/extension/html-language-features/`
20-
- Dependencies for `/extension/html-language-features/server/`
21-
- devDependencies such as `gulp`
22-
- Open `/extensions/html-language-features/` as the workspace in VS Code
23-
- Run the [`Launch Extension`](https://github.com/Microsoft/vscode/blob/master/extensions/html-language-features/.vscode/launch.json) debug target in the Debug View. This will:
24-
- Launch the `preLaunchTask` task to compile the extension
25-
- Launch a new VS Code instance with the `html-language-features` extension loaded
26-
- You should see a notification saying the development version of `html-language-features` overwrites the bundled version of `html-language-features`
27-
- Test the behavior of this extension by editing html files
28-
- Run `Reload Window` command in the launched instance to reload the extension
29-
30-
### Contribute to vscode-html-languageservice
31-
32-
[Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice) contains the language smarts for html.
33-
This extension wraps the html language service into a Language Server for VS Code.
34-
If you want to fix html issues or make improvements, you should make changes at [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice).
35-
36-
However, within this extension, you can run a development version of `vscode-html-languageservice` to debug code or test language features interactively:
37-
38-
#### Linking `vscode-html-languageservice` in `html-language-features/server/`
39-
40-
- Clone [Microsoft/vscode-html-languageservice](https://github.com/Microsoft/vscode-html-languageservice)
41-
- Run `yarn` in `vscode-html-languageservice`
42-
- Run `yarn link` in `vscode-html-languageservice`. This will compile and link `vscode-html-languageservice`
43-
- In `html-language-features/server/`, run `npm link vscode-html-languageservice`
44-
45-
#### Testing the development version of `vscode-html-languageservice`
46-
47-
- Open both `vscode-html-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature
48-
- Run `yarn watch` at `html-languagefeatures/server/` to recompile this extension with the linked version of `vscode-html-languageservice`
49-
- Make some changes in `vscode-html-languageservice`
50-
- Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-html-languageservice`. You can interactively test the language features.
51-
- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-html-languageservice` and `html-language-features/server/`

0 commit comments

Comments
 (0)