Small improvements to how to contribute #305
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I thought it was confusing that there were two different places where you would be 'cd'ing into vscode. Since you can read through both of these one after another, someone who doesn't know that there isn't a vscode folder inside of the vscode repo might be confused as to where they should be. Having the 'cd vscode' appear just once when you create the repo made more sense to me.
"You can open the `vscode` folder" is ambiguous as to where the folder should be opened. Because of this I changed the wording to be a bit clearer and added a "code ." suggestion as that would be easier for most developers to follow at the point the previous steps put them into the vscode folder.
When following this guide, the build step was failing with both methods. I didn't know why it wasn't working until I realized that my path contained spaces and that was breaking things. To help future users I added a warning and troubleshooting tip so that people can avoid this mistake in the future or people who also make this mistake will have less trouble resolving it.
Tyriar
reviewed
Jan 6, 2025
Comment on lines
+88
to
+89
| > Make sure that the path to your local clone does not contain spaces. | ||
| > This can cause issues with later steps. |
There was a problem hiding this comment.
What sort of problems does this cause exactly?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed three small issues I ran into while following the How-To-Contribute.md guide.
See commit messages for more details.