From ac7581a14a39a074e395096c34f34d052c834c71 Mon Sep 17 00:00:00 2001
From: Mathew Pareles <51329589+mathewpareles@users.noreply.github.com>
Date: Tue, 17 Sep 2024 16:34:23 -0700
Subject: [PATCH] Update CONTRIBUTING.md
---
CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++--------
1 file changed, 37 insertions(+), 8 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9b965d06..b3540342 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,12 +20,33 @@ For some useful links we've compiled see [`VOID_USEFUL_LINKS.md`](https://github
## 1. Building the Extension
Here's how you can start contributing to the Void Extension, where much of our code lives right now:
-1. Clone the repository: ```git clone https://github.com/voideditor/void```
-2. Open the extension folder in VS Code (open it in a new workspace, *don't* just cd into it): ```/extensions/void```
-3. Install dependencies: ```yarn```
-4. Build the project: `yarn run build` or `npm run build`. (We created this build command so that we could run React in vscode - it converts `sidebar/index.tsx` into a CSS/JS bundle in `dist/`.)
-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 Ctrl+Shift+P, select "Debug: Start Debugging", and select "VS Code Extension Development".
+1. Clone the repository:
+
+```
+git clone https://github.com/voideditor/void
+```
+
+2. Open the extension folder in VS Code (open it in a new workspace, *don't* just cd into it):
+
+```
+/extensions/void
+```
+
+3. Install dependencies:
+
+```
+npm install
+```
+
+4. Build the project. We created this build command so that we could run React in vscode - it converts `sidebar/index.tsx` into a CSS/JS bundle in `dist/`.
+
+```
+npm run build
+```
+
+5. Run the project by pressing F5.
+
+This will start a new instance of VS Code with the extension enabled. If this does not work, you can press Ctrl+Shift+P, 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".
@@ -35,9 +56,17 @@ Now that you're set up, feel free to check out our [Issues](https://github.com/v
Beyond the extension, we very occasionally edit the IDE when we need to access more functionality. If you want to work on the full IDE, 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`.
+
+1. Install all dependencies. Make sure you have yarn installed (`npm install -g yarn`)
+```
+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".
+
+3. Run `./scripts/code.sh` in your terminal.
+
+This should open up the built IDE after loading for some time. 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)