|
2 | 2 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
3 | 3 | # Contributing |
4 | 4 |
|
5 | | -- [Requirements](#requirements) |
6 | | - - [Linux-specific requirements](#linux-specific-requirements) |
7 | | -- [Creating pull requests](#creating-pull-requests) |
8 | | - - [Commits and commit history](#commits-and-commit-history) |
9 | | -- [Development workflow](#development-workflow) |
10 | | - - [Updates to VS Code](#updates-to-vs-code) |
11 | | - - [Build](#build) |
12 | | - - [Help](#help) |
13 | | -- [Test](#test) |
14 | | - - [Unit tests](#unit-tests) |
15 | | - - [Script tests](#script-tests) |
16 | | - - [Integration tests](#integration-tests) |
17 | | - - [End-to-end tests](#end-to-end-tests) |
18 | | -- [Structure](#structure) |
19 | | - - [Modifications to VS Code](#modifications-to-vs-code) |
20 | | - - [Currently Known Issues](#currently-known-issues) |
| 5 | +- [Contributing](#contributing) |
| 6 | + - [Requirements](#requirements) |
| 7 | + - [Linux-specific requirements](#linux-specific-requirements) |
| 8 | + - [Creating pull requests](#creating-pull-requests) |
| 9 | + - [Commits and commit history](#commits-and-commit-history) |
| 10 | + - [Development workflow](#development-workflow) |
| 11 | + - [Updates to VS Code](#updates-to-vs-code) |
| 12 | + - [Build](#build) |
| 13 | + - [Help](#help) |
| 14 | + - [Test](#test) |
| 15 | + - [Unit tests](#unit-tests) |
| 16 | + - [Script tests](#script-tests) |
| 17 | + - [Integration tests](#integration-tests) |
| 18 | + - [End-to-end tests](#end-to-end-tests) |
| 19 | + - [Structure](#structure) |
| 20 | + - [Modifications to VS Code](#modifications-to-vs-code) |
| 21 | + - [Currently Known Issues](#currently-known-issues) |
21 | 22 |
|
22 | 23 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
23 | 24 |
|
@@ -84,23 +85,22 @@ Here are these steps you should follow to get your dev environment setup: |
84 | 85 |
|
85 | 86 | 1. `git clone https://github.com/cdr/code-server.git` - Clone `code-server` |
86 | 87 | 2. `git clone https://github.com/cdr/vscode.git` - Clone `vscode` |
87 | | -3. `cd vscode && git checkout code-server-v2` - checkout the branch we use (not the default) |
88 | | -4. `cd vscode && yarn install` - install the dependencies in the `vscode` repo |
89 | | -5. `cd code-server && yarn install` - install the dependencies in the `code-server` repo |
90 | | -6. `cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package) |
91 | | -7. `cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server |
92 | | -8. `cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source. |
| 88 | +3. `cd vscode && yarn install` - install the dependencies in the `vscode` repo |
| 89 | +4. `cd code-server && yarn install` - install the dependencies in the `code-server` repo |
| 90 | +5. `cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package) |
| 91 | +6. `cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server |
| 92 | +7. `cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source. |
93 | 93 |
|
94 | 94 | ### Updates to VS Code |
95 | 95 |
|
96 | | -If changes are made and merged into `code-server-v2` in the `cdr/vscode` repo, then you'll need to update the version in the `code-server` repo by following these steps: |
| 96 | +If changes are made and merged into `main` in the [`cdr/vscode`](https://github.com/cdr/vscode) repo, then you'll need to update the version in the `code-server` repo by following these steps: |
97 | 97 |
|
98 | 98 | 1. Update the package tag listed in `vendor/package.json`: |
99 | 99 |
|
100 | 100 | ```json |
101 | 101 | { |
102 | 102 | "devDependencies": { |
103 | | - "vscode": "cdr/vscode#X.XX.X-code-server" |
| 103 | + "vscode": "cdr/vscode#<latest-commit-sha>" |
104 | 104 | } |
105 | 105 | } |
106 | 106 | ``` |
|
0 commit comments