Skip to content

Commit ec86aa7

Browse files
committed
docs: update global requirements for CONTRIBUTING
1 parent 638b2d5 commit ec86aa7

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/CONTRIBUTING.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,23 @@ master).
3131

3232
The prerequisites for contributing to code-server are almost the same as those for
3333
[VS Code](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).
34-
There are several differences, however. You must:
35-
36-
- Use Node.js version 12.x (or greater)
37-
- Have [yarn](https://classic.yarnpkg.com/en/) installed (which is used to install JS packages and run development scripts)
38-
- 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
39-
40-
The [CI container](../ci/images/debian10/Dockerfile) is a useful reference for all
41-
of the dependencies code-server uses.
34+
There are several differences, however. Here is what is needed:
35+
36+
- `node` v12.x or greater
37+
- `git` v2.x or greater
38+
- [`yarn`](https://classic.yarnpkg.com/en/)
39+
- used to install JS packages and run scripts
40+
- [`nfpm`](https://classic.yarnpkg.com/en/)
41+
- used to build `.deb` and `.rpm` packages
42+
- [`jq`](https://stedolan.github.io/jq/)
43+
- used to build code-server releases
44+
- [`gnupg`](https://gnupg.org/index.html)
45+
- all commits must be signed an verified
46+
- 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)
47+
- `build-essential` (Linux)
48+
- `apt-get install -y build-essential` - used by VS Code
49+
- `rsync` and `unzip`
50+
- used for code-server releases
4251

4352
## Development Workflow
4453

0 commit comments

Comments
 (0)