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

Jump to bottom

Update contributing docs to encourage a shallow clone to decrease download size #6517

Closed
jlengstorf opened this issue Jul 18, 2018 · 0 comments · Fixed by #6520
Closed

Update contributing docs to encourage a shallow clone to decrease download size #6517

jlengstorf opened this issue Jul 18, 2018 · 0 comments · Fixed by #6520
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@jlengstorf
Copy link
Contributor

jlengstorf commented Jul 18, 2018 •
edited

In the contributing docs, let's update to encourage a shallow clone:

git clone --depth=1 https://github.com/<your-username>/gatsby.git

I just ran a test locally and this reduced the cloned repo size by over 100MB. Per @KyleAMathews's feedback, shallow clones will cause no issues for 99% of contributors (really it only affects core maintainers who may need to rewrite history — which isn't something that we really ever want to do in the first place).

This would be a great first contribution for someone! 💪💜
@jlengstorf jlengstorf mentioned this issue Jul 18, 2018
Closed
@jlengstorf jlengstorf added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation good first issue Issue that doesn't require previous experience with Gatsby labels Jul 18, 2018
@gatsbyjs gatsbyjs deleted a comment from gatsbot bot Jul 18, 2018
@kylewayneluck kylewayneluck mentioned this issue Jul 18, 2018
Merged
KyleAMathews pushed a commit that referenced this issue Jul 18, 2018
@kylewayneluck @KyleAMathews
Update contributing docs (#6520)
27a4f4b 
Closes #6517
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update contributing docs
1 participant
@jlengstorf