Archived
1
0
This repository has been archived on 2024-09-09. You can view files and clone it, but cannot push or open issues or pull requests.
code-server/doc/CONTRIBUTING.md
Anmol Sethi 1739b21600
Bundle VS Code node_modules to avoid yarn dependency
Many random bizarre issues otherwise.

Also includes misc improvements to docs and scripts.
2020-05-13 02:35:11 -04:00

1.3 KiB

Contributing

Requirements

Please refer to VS Code's prerequisites.

Differences:

  • We are not constrained by node version
  • We use fnpm to build .deb and .rpm packages

Development Workflow

yarn
yarn vscode
yarn watch # Visit http://localhost:8080 once completed.

To develop inside of an isolated docker container:

./ci/dev/container/exec.sh

root@12345:/code-server# yarn
root@12345:/code-server# yarn vscode
root@12345:/code-server# yarn watch

Any changes made to the source will be live reloaded.

If changes are made to the patch and you've built previously you must manually reset VS Code then run yarn vscode:patch.

Some docs are available at ../src/node/app on how code-server works internally.

Build

yarn
yarn vscode
yarn build
yarn build:vscode
yarn release
cd release
yarn --production
node . # Run the built JavaScript with Node.

Now you can make it static and build packages with:

yarn release:static
yarn test:static-release
yarn package

The static release will be in ./release-static and .deb, .rpm and self-contained release in ./release-packages.