-
Notifications
You must be signed in to change notification settings - Fork 628
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into model-selection
- Loading branch information
Showing
1 changed file
with
37 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,20 +4,19 @@ Welcome! 👋 This is the official guide on how to contribute to Void. We want t | |
|
|
||
| There are a few ways to contribute: | ||
|
|
||
| - Suggest New Features ([Discord](https://discord.gg/RSNjgaugJs)) | ||
| - Build New Features ([Project](https://github.com/orgs/voideditor/projects/2/views/3)) | ||
| - Submit Issues/Docs/Bugs ([Issues](https://github.com/voideditor/void/issues)) | ||
| - 👨💻 Build new features - see [Issues](https://github.com/voideditor/void/issues). | ||
| - 💡 Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs). | ||
| - ⭐️ If you want to build your AI tool into Void, feel free to get in touch! It's very easy to extend Void, and the UX you create will be much more natural than a VSCode Extension. | ||
|
|
||
| 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/`. | ||
| ## Building the full IDE | ||
|
|
||
| ### 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 | ||
|
|
||
|
|
@@ -28,38 +27,39 @@ Go to the "Workloads" tab and select: | |
| - `Node.js build tools` | ||
|
|
||
| Go to the "Individual Components" tab and select: | ||
| - `MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)`, | ||
| - `C++ ATL for latest build tools with Spectre Mitigations`, | ||
| - `C++ MFC for latest build tools with Spectre Mitigations`. | ||
| - `MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)` | ||
| - `C++ ATL for latest build tools with Spectre Mitigations` | ||
| - `C++ MFC for latest build tools with Spectre Mitigations` | ||
|
|
||
| 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 <kbd>Cmd+Shift+B</kbd> (Mac). | ||
| - Press <kbd>Ctrl+Shift+B</kbd> (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 <kbd>Ctrl+Shift+P</kbd> 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 <kbd>Ctrl+Shift+B</kbd>, or if you prefer using the terminal run `npm run watch`. | ||
| #### Building Void from Terminal | ||
|
|
||
| This can take ~5 min. | ||
|
|
||
| If you ran <kbd>Ctrl+Shift+B</kbd>, 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 <kbd>Cmd+Shift+B</kbd> 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 +68,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 | ||
| ``` | ||
|
|
||
| <!-- 3. Press <kbd>Ctrl+Shift+B</kbd> to start the build process. --> | ||
|
|
||
| 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 <kbd>Ctrl+Shift+P</kbd> 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 [email protected]` 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) | ||
|
|
@@ -99,29 +97,20 @@ We don't usually recommend bundling. Instead, you should probably just build (ab | |
| - `npm run gulp vscode-linux-arm` | ||
| - `npm run gulp vscode-linux-ia32` | ||
|
|
||
| ## Roadmap | ||
|
|
||
| Please refer to our [Issues](https://github.com/voideditor/void/issues) page for the latest issues. | ||
|
|
||
|
|
||
| ## ⭐⭐⭐ Creative. | ||
|
|
||
| Examples: creating better code search, or supporting AI agents that can edit across files and make multiple LLM calls. | ||
|
|
||
| Eventually, we want to build a convenient API for creating AI tools. The API will provide methods for creating the UI (showing an autocomplete suggestion, or creating a new diff), detecting event changes (like `onKeystroke` or `onFileOpen`), and modifying the user's file-system (storing indexes associated with each file), making it much easier to make your own AI plugin. We plan on building these features further along in timeline, but we wanted to list them for completeness. | ||
|
|
||
| # Guidelines | ||
|
|
||
| We're always glad to talk about new ideas, help you get set up, and make sure your changes align with our vision for the project. Feel free to shoot us a message in the #general channel of the [Discord](https://discord.gg/RSNjgaugJs) for any reason. Please check in especially if you want to make a lot of changes or build a large new feature. | ||
|
|
||
| We're always glad to talk about new ideas, help you get set up, and make sure your changes align with our vision for the project! Feel free to shoot Mat or Andrew a message, or start chatting with us in the `#contributing` channel of our [Discord](https://discord.gg/RSNjgaugJs). | ||
|
|
||
|
|
||
| ## Submitting a Pull Request | ||
|
|
||
| Please submit a pull request once you've made a change. You don't need to submit an issue. | ||
| - Please submit a pull request once you've made a change. No need to submit an Issue unless you're creating a new feature. | ||
| - Please don't use AI to write your PR 🙂. | ||
|
|
||
| Please don't use AI to write your PR 🙂. | ||
|
|
||
| <!-- | ||
| # Relevant files | ||
| We keep track of all the files we've changed with Void so it's easy to rebase: | ||
|
|
@@ -145,7 +134,7 @@ We keep track of all the files we've changed with Void so it's easy to rebase: | |
| - build/npm/dirs.js | ||
| - vscode.proposed.editorInsets.d.ts - not modified, but code copied | ||
|
|
||
| --> | ||
|
|
||
| ## References | ||
|
|
||
|
|
||