Skip to content

Commit

Permalink
docs: suggest cloning with depth=1 to avoid huge downloads (#36064)
Browse files Browse the repository at this point in the history
* docs: suggest cloning with depth=1 to avoid huge downloads

* Update contributing.md

Co-authored-by: JJ Kasper <jj@jjsweb.site>

* lint-fix

Co-authored-by: JJ Kasper <jj@jjsweb.site>
  • Loading branch information
gsimone and ijjk committed Apr 11, 2022
1 parent 5053026 commit 807abde
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions contributing.md
Expand Up @@ -19,6 +19,13 @@ To develop locally:
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
own GitHub account and then
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.

If you don't need the whole git history, you can clone with depth 1 to reduce the download size (~1.6GB):

```sh
git clone --depth=1 https://github.com/vercel/next.js
```

2. Create a new branch:
```
git checkout -b MY_BRANCH_NAME
Expand Down

0 comments on commit 807abde

Please sign in to comment.