Skip to content

Commit 2075f4b

Browse files
committed
docs(MAINTAINING): add section for syncing VS Code upstream
1 parent b1566df commit 2075f4b

File tree

2 files changed

+30
-19
lines changed

2 files changed

+30
-19
lines changed

docs/CONTRIBUTING.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,22 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
# Contributing
44

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)
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)
2221

2322
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2423

docs/MAINTAINING.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- [Docker](#docker)
2020
- [Homebrew](#homebrew)
2121
- [npm](#npm)
22+
- [Syncing with Upstream VS Code](#syncing-with-upstream-vs-code)
2223
- [Testing](#testing)
2324
- [Documentation](#documentation)
2425
- [Troubleshooting](#troubleshooting)
@@ -126,8 +127,7 @@ the issue.
126127

127128
### Merge strategies
128129

129-
For most things, we recommend the **squash and merge** strategy. If you're
130-
updating `lib/vscode`, we suggest using the **rebase and merge** strategy. There
130+
For most things, we recommend the **squash and merge** strategy. There
131131
may be times where **creating a merge commit** makes sense as well. Use your
132132
best judgment. If you're unsure, you can always discuss in the PR with the team.
133133

@@ -215,6 +215,18 @@ We publish code-server as a npm package [here](https://www.npmjs.com/package/cod
215215

216216
This is currently automated with the release process.
217217

218+
## Syncing with Upstream VS Code
219+
220+
The VS Code portion of code-server lives under [`cdr/vscode`](https://github.com/cdr/vscode). To update VS Code for code-server, follow these steps:
221+
222+
1. `git checkout -b vscode-update` - Create a new branch locally based off `main`
223+
2. `git fetch upstream` - Fetch upstream (VS Code)'s latest `main` branch
224+
3. `git merge upstream/main` - Merge it locally
225+
1. If there are merge conflicts, fix them locally
226+
4. Open a PR merging your branch (`vscode-update`) into `main` and add the code-server review team
227+
228+
Ideally, our fork stays as close to upstream as possible. See the differences between our fork and upstream [here](https://github.com/microsoft/vscode/compare/main...cdr:main).
229+
218230
## Testing
219231

220232
Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).

0 commit comments

Comments
 (0)