cubetiq/code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update global requirements for CONTRIBUTING

Browse Source
This commit is contained in:
Joe Previte 2021-04-14 16:19:09 -07:00
parent 638b2d5dd5
commit ec86aa7ab1
No known key found for this signature in database
GPG Key ID: 2C91590C6B742C24
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/CONTRIBUTING.md
View File

@ -31,14 +31,23 @@ master).
The prerequisites for contributing to code-server are almost the same as those for The prerequisites for contributing to code-server are almost the same as those for
[VS Code](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). [VS Code](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).
There are several differences, however. You must: There are several differences, however. Here is what is needed:
- Use Node.js version 12.x (or greater) - `node` v12.x or greater
- Have [yarn](https://classic.yarnpkg.com/en/) installed (which is used to install JS packages and run development scripts) - `git` v2.x or greater
- Have [nfpm](https://github.com/goreleaser/nfpm) (which is used to build `.deb` and `.rpm` packages and [jq](https://stedolan.github.io/jq/) (used to build code-server releases) installed - [`yarn`](https://classic.yarnpkg.com/en/)
- used to install JS packages and run scripts
The [CI container](../ci/images/debian10/Dockerfile) is a useful reference for all - [`nfpm`](https://classic.yarnpkg.com/en/)
of the dependencies code-server uses. - used to build `.deb` and `.rpm` packages
- [`jq`](https://stedolan.github.io/jq/)
- used to build code-server releases
- [`gnupg`](https://gnupg.org/index.html)
- all commits must be signed an verified
- see GitHub's ["Managing commit signature verification"](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification) or follow [this tutorial](https://joeprevite.com/verify-commits-on-github)
- `build-essential` (Linux)
- `apt-get install -y build-essential` - used by VS Code
- `rsync` and `unzip`
- used for code-server releases
## Development Workflow ## Development Workflow