2020-02-19 08:07:01 +08:00
|
|
|
# Contributing
|
|
|
|
|
|
2020-04-30 19:52:54 +08:00
|
|
|
- [Detailed CI and build process docs](../ci)
|
|
|
|
|
- [Our VS Code Web docs](../src/node/app)
|
|
|
|
|
|
2020-02-19 08:07:01 +08:00
|
|
|
## Development Workflow
|
|
|
|
|
|
|
|
|
|
- [VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
yarn
|
|
|
|
|
yarn vscode
|
|
|
|
|
yarn watch # Visit http://localhost:8080 once completed.
|
|
|
|
|
```
|
|
|
|
|
|
2020-04-15 06:22:52 +08:00
|
|
|
To develop inside of an isolated docker container:
|
|
|
|
|
|
|
|
|
|
```shell
|
2020-04-30 19:52:54 +08:00
|
|
|
./ci/dev/container/exec.sh
|
2020-04-15 06:22:52 +08:00
|
|
|
|
|
|
|
|
root@12345:/code-server# yarn
|
|
|
|
|
root@12345:/code-server# yarn vscode
|
|
|
|
|
root@12345:/code-server# yarn watch
|
|
|
|
|
```
|
|
|
|
|
|
2020-02-19 08:07:01 +08:00
|
|
|
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](../src/node/app) on how code-server
|
|
|
|
|
works internally.
|
|
|
|
|
|
|
|
|
|
## Build
|
|
|
|
|
|
|
|
|
|
- [VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
yarn
|
2020-02-27 04:48:08 +08:00
|
|
|
yarn vscode
|
2020-02-19 08:07:01 +08:00
|
|
|
yarn build
|
2020-04-30 19:52:54 +08:00
|
|
|
yarn build:vscode
|
|
|
|
|
yarn release
|
|
|
|
|
node ./release # Run the built JavaScript with Node.
|
2020-02-19 08:07:01 +08:00
|
|
|
```
|
