diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d53dedf..8669ba6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,16 +8,13 @@ There are a few ways to contribute: - Build New Features ([Project](https://github.com/orgs/voideditor/projects/2/views/3)) - Submit Issues/Docs/Bugs ([Issues](https://github.com/voideditor/void/issues)) +Most of Void's code lives in `src/vs/workbench/contrib/void/browser/` and `src/vs/platform/void/`. ## Building the full IDE -Please follow the steps below to build the IDE. If you have any questions, feel free to [submit an issue](https://github.com/voideditor/void/issues/new) with any build errors, or refer to VSCode's full [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. - -Most of Void's code lives in `src/vs/workbench/contrib/void/browser/` and `src/vs/platform/void/`. - ### a. Build Prerequisites - Mac -If you're using a Mac, make sure you have Python and XCode installed (you probably do by default). +If you're using a Mac, you need Python and XCode. You probably have these by default. ### b. Build Prerequisites - Windows @@ -36,30 +33,31 @@ Finally, click Install. ### c. Build Prerequisites - Linux -First, make sure you've installed NodeJS and run `npm install -g node-gyp`. Then: -- Debian (Ubuntu, etc) - `sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev libkrb5-dev python-is-python3`. -- Red Hat (Fedora, etc) - `sudo dnf install @development-tools gcc gcc-c++ make libsecret-devel krb5-devel libX11-devel libxkbfile-devel`. -- Others - see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute). +First, run `npm install -g node-gyp`. Then: -### Build instructions +- Debian (Ubuntu, etc): `sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev libkrb5-dev python-is-python3`. +- Red Hat (Fedora, etc): `sudo dnf install @development-tools gcc gcc-c++ make libsecret-devel krb5-devel libX11-devel libxkbfile-devel`. +- Others: see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute). -To build Void, first follow the prerequisite steps above for your operating system and open `void/` inside VSCode. Then: +### Building Void -1. Install all dependencies. +To build Void, open `void/` inside VSCode. Then: -``` -npm install -``` +1. `npm install` to install all dependencies. +2. `npm run buildreact` to build Void's browser dependencies like React. +3. Build. + - Press Cmd+Shift+B (Mac). + - Press Ctrl+Shift+B (Windows/Linux). + - This step can take ~5 min. The build is done when you see two check marks. +4. Run. + - Run `./scripts/code.sh` (Mac/Linux). + - Run `./scripts/code.bat` (Windows). + - This command should open up the built IDE. You can always press Ctrl+Shift+P and run "Reload Window" inside the new window to see changes without re-building, unless they're React changes. -2. Run `npm run buildreact` to build Void's browser-based external dependencies (our React components, etc). -3. Press Ctrl+Shift+B, or if you prefer using the terminal run `npm run watch`. +#### Building Void from Terminal -This can take ~5 min. - -If you ran Ctrl+Shift+B, the build is done when you see two check marks. - -If you ran `npm run watch`, the build is done when you see something like this: +Alternatively, if you want to build Void from the terminal, instead of pressing Cmd+Shift+B you can run `npm run watch`. The build is done when you see something like this: ``` [watch-extensions] [00:37:39] Finished compilation extensions with 0 errors after 19303 ms @@ -68,23 +66,21 @@ If you ran `npm run watch`, the build is done when you see something like this: [watch-client ] [00:38:07] Finished compilation with 0 errors after 5 ms ``` - -4. In a new terminal, run `./scripts/code.sh` (Mac/Linux) or `./scripts/code.bat` (Windows). This should open up the built IDE. -You can always press Ctrl+Shift+P and run "Reload Window" inside the new window to see changes without re-building. - -Now that you're set up, feel free to check out our [Issues](https://github.com/voideditor/void/issues) page. ### Common Fixes +- Make sure you follow the prerequisite steps. - Make sure you have the same NodeJS version as `.nvmrc`. +- If you make any React changes, you must re-run `npm run buildreact` and re-build. +- If you have any questions, feel free to [submit an issue](https://github.com/voideditor/void/issues/new). For building questions, you can also refer to VSCode's full [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. + -- If you see `[ERROR] Cannot start service: Host version "0.23.1" does not match binary version "0.23.0"`, run `npm i -D esbuild@0.23.0` or do a clean install of your npm dependencies. ## Bundling -We don't usually recommend bundling. Instead, you should probably just build (above). If you're sure you want to bundle Void into an executable app, run one of the following commands. This will create a folder named `VSCode-darwin-arm64` (or similar) in the repo's parent's directory. Be patient - compiling can take ~25 minutes. +We don't usually recommend bundling. Instead, you should probably just build. If you're sure you want to bundle Void into an executable app, run one of the following commands. This will create a folder named `VSCode-darwin-arm64` (or similar) in the repo's parent's directory. Be patient - compiling can take ~25 minutes. ### Mac - `npm run gulp vscode-darwin-arm64` - most common (Apple Silicon)