code-server/doc/CONTRIBUTING.md

41 lines
923 B
Markdown
Raw Normal View History

2020-02-19 07:07:01 +07:00
# Contributing
## 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 05:22:52 +07:00
To develop inside of an isolated docker container:
```shell
./ci/dev-image/exec.sh
root@12345:/code-server# yarn
root@12345:/code-server# yarn vscode
root@12345:/code-server# yarn watch
```
2020-02-19 07:07:01 +07: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 07:07:01 +07:00
yarn build
2020-03-23 16:26:54 +07:00
node ./build/out/node/entry.js # Run the built JavaScript with Node.
2020-02-19 07:07:01 +07:00
```