- [Creating pull requests](#creating-pull-requests)

- [Commits and commit history](#commits-and-commit-history)

- [Detailed CI and build process docs](../ci)

for [VS

Code](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).

If you're developing code-server on Linux, make sure you have installed or install the following dependencies:

These are required by Code. See [their Wiki](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites) for more information.

Please create a [GitHub Issue](https://github.com/coder/code-server/issues) that

includes context for issues that you see. You can skip this if the proposed fix

is minor.

In your pull requests (PR), link to the issue that the PR solves.

Please ensure that the base of your PR is the **main** branch.

We prefer a clean commit history. This means you should squash all fixups and

fixup-type commits before asking for a review (e.g., clean up, squash, then force

push). If you need help with this, feel free to leave a comment in your PR, and

we'll guide you.

1. Update the `lib/vscode` submodule to the desired upstream version branch.

1. `cd lib/vscode && git checkout release/1.66 && cd ../..`

2. `git add lib && git commit -m "chore: update Code"`

2. Apply the patches (`quilt push -a`) or restore your stashed changes. At this

stage you may need to resolve conflicts. For example use `quilt push -f`,

manually apply the rejected portions, then `quilt refresh`.

3. From the code-server **project root**, run `yarn install`.

4. Test code-server locally to make sure everything works.

5. Check the Node.js version that's used by Electron (which is shipped with VS

Code. If necessary, update your version of Node.js to match.

6. Commit the updated submodule and patches to `code-server`.

7. Open a PR.

while quilt push; do quilt refresh; done

[Source](https://raphaelhertzog.com/2012/08/08/how-to-use-quilt-to-manage-patches-in-debian-packages/)

0. You can go through the patch stack with `quilt push` and `quilt pop`.

1. Create a new patch (`quilt new {name}.diff`) or use an existing patch.

1. Add the file(s) you are patching (`quilt add [-P patch] {file}`). A file

1. Make your changes. Patches do not need to be independent of each other but

1. Add your changes to the patch (`quilt refresh`)

1. Add a comment in the patch about the reason for the patch and how to

You can build as follows:

yarn build:vscode

_NOTE: this does not keep `node_modules`. If you want them to be kept, use `KEEP_MODULES=1 yarn release` (if you're testing in Coder, you'll want to do this)_

Build the release packages (make sure that you run `yarn release` first):

- macOS amd64 (Intel-based)

Currently, these are compiled in CI using the `yarn release-standalone` command

This means your patches didn't apply correctly. We have a patch to remove the auth from vanilla Code because we use our own.

Try popping off the patches with `quilt pop -a` and reapplying with `quilt push -a`.

Code might be trying to use a dev or prod HTML in the wrong context. You can try re-running code-server and setting `VSCODE_DEV=1`.

If you get stuck or need help, you can always start a new GitHub Discussion [here](https://github.com/coder/code-server/discussions). One of the maintainers will respond and help you out.

We use unit tests for functions and things that can be tested in isolation. The file structure is modeled closely after `/src` so it's easy for people to know where test files should live.

We use these to test anything related to our scripts (most of which live under `ci`).

These are a work in progress. We build code-server and run tests with `yarn test:integration`, which ensures that code-server builds work on their respective

platforms.

Generally speaking, e2e means testing code-server while running in the browser

and interacting with it in a way that's similar to how a user would interact

with it. When running these tests with `yarn test:e2e`, you must have

code-server running locally. In CI, this is taken care of for you.

The `code-server` script serves as an HTTP API for login and starting a remote

Code process.