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.

Sign up for GitHub

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

Small improvements to how to contribute #305

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Small improvements to how to contribute #305

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb90e0f
Move "cd vscode" to one place instead of two
mxd1760 Jan 5, 2025
cab923b
Add footnote for clarity
mxd1760 Jan 5, 2025
804f15b
Add warning for path with spaces
mxd1760 Jan 5, 2025
27ebb44
Merge branch 'main' into small-improvements-to-how-to-contribute
mxd1760 Jan 26, 2025
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
10 changes: 7 additions & 3 deletions How-to-Contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,18 @@ If you want to understand how VS Code works or want to debug an issue, you'll wa

First, fork the VS Code repository so that you can make a pull request. Then, clone your fork locally:

> [!Warning]
> Make sure that the path to your local clone does not contain spaces.
> This can cause issues with later steps.
Comment on lines +90 to +91
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What sort of problems does this cause exactly?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember exactly how it was failing, but it would fail halfway through the build step. I noticed the error had the path up to the space, so I changed that, and then it started building successfully.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also added a bullet in the troubleshooting section under the build step to solve this problem, but I thought something to help avoid the issue entirely would be prudent as well.


```
git clone https://github.com/<<<your-github-account>>>/vscode.git
cd vscode
```

Occasionally you will want to merge changes in the upstream repository (the official code repo) with your fork.

```
cd vscode
git checkout main
git pull https://github.com/microsoft/vscode.git main
```
Expand All @@ -105,19 +109,19 @@ Manage any merge conflicts, commit them, and then push them to your fork.
Install and build all of the dependencies using `npm`:

```
cd vscode
npm i
```

Then you have two options:

- If you want to build from inside VS Code, you can open the `vscode` folder and start the build task with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> (<kbd>CMD</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> on macOS). The build task will stay running in the background even if you close VS Code. If you happen to close VS Code and open it again, just resume the build by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> (<kbd>CMD</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd>) again. You can kill it by running the `Kill Build VS Code` task or pressing <kbd>Ctrl</kbd>+<kbd>D</kbd> in the task terminal.
- If you want to build from inside VS Code, open the `vscode` folder in vscode (`code .`) and start the build task with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> (<kbd>CMD</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> on macOS). The build task will stay running in the background even if you close VS Code. If you happen to close VS Code and open it again, just resume the build by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> (<kbd>CMD</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd>) again. You can kill it by running the `Kill Build VS Code` task or pressing <kbd>Ctrl</kbd>+<kbd>D</kbd> in the task terminal.
- If you want to build from a terminal, run `npm run watch`. This will run both the core watch task and watch-extension tasks in a single terminal.

The incremental builder will do an initial full build and will display a message that includes the phrase "Finished compilation" once the initial build is complete. The builder will watch for file changes and compile those changes incrementally, giving you a fast, iterative coding experience.

**Troubleshooting:**

- Make sure that the path to your local clone of the repo does not contain spaces.
- **Windows:** If you have installed Visual Studio 2017 as your build tool, you need to open **x64 Native Tools Command Prompt for VS 2017**. Do not confuse it with *VS2015 x64 Native Tools Command Prompt*, if installed.
- **Linux:** You may hit a ENOSPC error when running the build. To get around this follow instructions in the [Common Questions](https://code.visualstudio.com/docs/setup/linux#_common-questions).

Expand Down