Skip to content

Commit 085b73b

Browse files
committed
docs: add note regarding spaces in directory path
1 parent 105db06 commit 085b73b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,17 @@ Create a [GitHub account][github-signup]. The project uses GitHub exclusively fo
118118
$ git clone https://github.com/<username>/stdlib.git
119119
```
120120

121-
where `<username>` is your GitHub username. The repository has a large commit history, leading to slow download times. You can reduce the download time by limiting the clone [depth][git-clone-depth].
121+
where `<username>` is your GitHub username. When cloning, avoid cloning to a directory having spaces in its path. Because this project relies heavily on `make`, any spaces in the directory path will lead to errors and inevitable frustration.
122+
123+
```text
124+
// Bad:
125+
/home/foo/bar/beep boop/stdlib
126+
127+
// Good:
128+
/home/foo/bar/beep_boop/stdlib
129+
```
130+
131+
The repository has a large commit history, leading to slow download times. You can reduce the download time by limiting the clone [depth][git-clone-depth].
122132

123133
<!-- run-disable -->
124134

0 commit comments

Comments
 (0)