code-server/doc/CONTRIBUTING.md

48 lines
1.0 KiB
Markdown
Raw Normal View History

2020-02-19 01:07:01 +01:00
# Contributing
- [Detailed CI and build process docs](../ci)
- [Our VS Code Web docs](../src/node/app)
2020-02-19 01:07:01 +01: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 00:22:52 +02:00
To develop inside of an isolated docker container:
```shell
./ci/dev/container/exec.sh
2020-04-15 00:22:52 +02:00
root@12345:/code-server# yarn
root@12345:/code-server# yarn vscode
root@12345:/code-server# yarn watch
```
2020-02-19 01:07:01 +01: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
yarn vscode
2020-02-19 01:07:01 +01:00
yarn build
yarn build:vscode
yarn release
2020-05-08 22:31:42 +02:00
cd release
yarn --production
node . # Run the built JavaScript with Node.
2020-02-19 01:07:01 +01:00
```