Skip to content

Commit 22cfdc3

Browse files
authored
Update Contribution Guide To Help Solve Potential Setup Error (#1225)
## Summary When I was following the contribution guide, all the steps worked except: `Tip: you can also start VSCode from inside your Devbox shell with devbox run code.` I was getting an error stating the command `code` was not found. I checked the file `devbox run code` was running, which is `.devbox/gen/scripts/code.sh`. In the file (line 3), it tries to run `code .` -> which only works if you have installed the Visual Studio shell command. ## How was it tested? Steps I took: 1. I could not run the command successfully without installing the Visual Studio shell command. 2. I installed the shell command. 3. The command ran successfully. ## Why Is It Useful? This is useful for developers who do not use Visual Studio Code as their primary IDE, therefore increasing the chances encountering an error on the beginning setup steps
1 parent b90a2aa commit 22cfdc3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ The easiest way to develop Devbox is with Devbox!
3030
dist/devbox shell
3131

3232
Tip: you can also start VSCode from inside your Devbox shell with `devbox run code`.
33+
- If you are encountering an error similar to: `line 3: command 'code' not found`, this means you do not have the Visual Studio Code "Shell Command" installed. To do this, follow the official guide: https://code.visualstudio.com/docs/setup/mac. Please refer to the section under: "Launching from the command line".
3334

3435
### Setting up the Environment Without Devbox
3536

0 commit comments

Comments
 (0)