Elgato_dark/void
1
0
Fork 0
mirror of https://github.com/voideditor/void synced 2026-05-23 09:28:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Andrew Pareles 2024-09-17 15:28:25 -07:00 committed by GitHub
parent fa977d7c9a
commit 8dd68351bc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 42 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
CONTRIBUTING.md
View file

@ -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 <kbd>F5</kbd>. This will start a new instance of VS Code with the extension enabled. If this does not work, you can press <kbd>F1</kbd>, 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 (<kbd>Ctrl+,</kbd>) 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 <kbd>Ctrl+Shift+B</kbd> 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 <kbd>Ctrl+Shift+P</kbd> 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 <kbd>F5</kbd>. This will start a new instance of VS Code with the extension enabled. If this does not work, you can press <kbd>F1</kbd>, 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 (<kbd>Ctrl+,</kbd>) 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 <kbd>Ctrl+Shift+B</kbd> 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 <kbd>Ctrl+Shift+P</kbd> 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.