Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc : Build command fix #121

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 8 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ We use a [VSCode extension](https://code.visualstudio.com/api/get-started/your-f
For some useful links we've compiled see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md).

## 1. Building the Extension

Here's how you can start contributing to the Void extension. This is where you should get started if you're new.

1. Clone the repository:
Expand All @@ -20,11 +21,7 @@ Here's how you can start contributing to the Void extension. This is where you s
git clone https://github.com/voideditor/void
```

2. Open the folder `/extensions/void` in VSCode (open it in a new workspace, *don't* just cd into it):

```
open /extensions/void in vscode
```
2. Open the folder `/extensions/void` in VSCode (open it in a new workspace, _don't_ just cd into it).

3. Install dependencies:

Expand All @@ -42,17 +39,13 @@ npm run build

This will start a new instance of VSCode with the extension enabled. If this doesn't work, you can press <kbd>Ctrl+Shift+P</kbd>, select "Debug: Start Debugging", and select "VSCode Extension Development".


## 2. Building the full IDE

If you want to work on the full IDE, please follow the steps below. If you have any questions/issues, you can refer to VSCode's full [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page, which is where the steps below come from. Also feel free to submit an issue or get in touch with us with any build errors.



### a. Building on a Mac

To build on a Mac, open `void/` in VSCode. Make sure you've built the extension by following the steps above (or just run `cd ./extensions/void && npm run build && npm run compile && cd ../..`). Also make sure you have Python and XCode installed on your system (you probably do by default).

To build on a Mac, open `void/` in VSCode. Make sure you've built the extension by following the steps above (or just run `cd ./extensions/void && npm install && npm run build && npm run compile && cd ../..`). Also make sure you have Python and XCode installed on your system (you probably do by default).

1. Install all dependencies.

Expand Down Expand Up @@ -81,12 +74,10 @@ To bundle the IDE, run `npm run gulp vscode-darwin-arm64`. Here are the full opt

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 have the same NodeJS version as `.nvmrc`.


### b. Building on Windows

To build on Windows, please refer to [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute). We recommend building on Mac; we're Windows users who switch to Mac to build right now.
Expand Down Expand Up @@ -124,7 +115,7 @@ Please don't make big refactors without speaking with us first. We'd like to kee

Please submit a pull request once you've made a change. Here are a few guidelines:

- A PR should be about one *single* feature change. The fewer items you change, the more likely the PR is to be accepted.
- A PR should be about one _single_ feature change. The fewer items you change, the more likely the PR is to be accepted.

- Your PR should contain a description that first explains at a high level what you did, and then describes the exact changes you made (and to which files). Please don't use vague statements like "refactored code" or "improved types" (instead, describe what code you refactored, or what types you changed).

Expand All @@ -142,11 +133,11 @@ We keep track of all the files we've changed with Void so it's easy to rebase:

- src/vs/workbench/api/common/{extHost.api.impl.ts | extHostApiCommands.ts}
- src/vs/workbench/workbench.common.main.ts
- src/vs/workbench/contrib/void/*
- extensions/void/*
- src/vs/workbench/contrib/void/\*
- extensions/void/\*

- .github/*
- .vscode/settings/*
- .github/\*
- .vscode/settings/\*
- .eslintrc.json
- build/hygiene.js
- build/lib/i18n.resources.json
Expand Down