From 8dd68351bcc35ccb6e2a4fe408d5865dbae97234 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Tue, 17 Sep 2024 15:28:25 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 84 ++++++++++++++++++++++++------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65913ab0..d574dd05 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,46 @@ +## 1. Building the Extension +Here's how you can start contributing to and building the Extension: + +1. Clone the repository + +```git clone https://github.com/voideditor/void``` + +2. Open the extension folder in VS Code + +```/extensions/void``` + +3. Install dependencies + +```yarn``` + +4. Build the project using `yarn run build` or `npm run build`. (We created this command so that we could run React in vscode - it converts `sidebar/index.tsx` into a CSS/JS bundle in `dist/`.) + +```yarn run build``` + +5. Run the project + +Press F5. This will start a new instance of VS Code with the extension enabled. If this does not work, you can press F1, select "Debug: Start Debugging", and select "VS Code Extension Development". + +If you would like to use AI features, you need to provide an API key. You can do that by going to Settings (Ctrl+,) and modifying `void > "Anthropic Api Key"`. The "Which API" environment variable controls the provider and defaults to "anthropic". + +## 2. Building the full IDE + +Beyond the extension, we sometimes edit the IDE when we need to access more functionality. If you want to build the full IDE after making a change, please follow the steps below, or see VS Code's full [how to contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. + +1. Install all dependencies by running `yarn`. + +2. Press Ctrl+Shift+B to start the build process - this can take some time. + +3. Run `./scripts/code.sh` to open up the built IDE. To see new changes without restarting the build, use Ctrl+Shift+P and run "Reload Window". + +To bundle the IDE, run `yarn gulp vscode-win32-x64`. Here are the full options: vscode-{win32-ia32 | win32-x64 | darwin-x64 | darwin-arm64 | linux-ia32 | linux-x64 | linux-arm}(-min) + +If you're on Windows, we recommend running the project inside a dev container. VSCode should prompt you to do this automatically. + + + + # Contributing to Void @@ -70,48 +112,6 @@ Eventually, we want to build a convenient API for creating AI tools. The API wil ⭐ Allow user to X out of their current selection. - -## 1. Building the Extension -Here's how you can start contributing to and building the Extension: - -1. Clone the repository - -```git clone https://github.com/voideditor/void``` - -2. Open the extension folder in VS Code - -```/extensions/void``` - -3. Install dependencies - -```yarn``` - -4. Build the project using `yarn run build` or `npm run build`. (We created this command so that we could run React in vscode - it converts `sidebar/index.tsx` into a CSS/JS bundle in `dist/`.) - -```yarn run build``` - -5. Run the project - -Press F5. This will start a new instance of VS Code with the extension enabled. If this does not work, you can press F1, select "Debug: Start Debugging", and select "VS Code Extension Development". - -If you would like to use AI features, you need to provide an API key. You can do that by going to Settings (Ctrl+,) and modifying `void > "Anthropic Api Key"`. The "Which API" environment variable controls the provider and defaults to "anthropic". - -## 2. Building the full IDE - -Beyond the extension, we sometimes edit the IDE when we need to access more functionality. If you want to build the full IDE after making a change, please follow the steps below, or see VS Code's full [how to contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. - -1. Install all dependencies by running `yarn`. - -2. Press Ctrl+Shift+B to start the build process - this can take some time. - -3. Run `./scripts/code.sh` to open up the built IDE. To see new changes without restarting the build, use Ctrl+Shift+P and run "Reload Window". - -To bundle the IDE, run `yarn gulp vscode-win32-x64`. Here are the full options: vscode-{win32-ia32 | win32-x64 | darwin-x64 | darwin-arm64 | linux-ia32 | linux-x64 | linux-arm}(-min) - -If you're on Windows, we recommend running the project inside a dev container. VSCode should prompt you to do this automatically. - - - # Submitting a Pull Request When you've made changes and want to submit them, please submit a pull request.