Document efficient repository cloning - #1090
Open
jamesmontemagno wants to merge 1 commit into
Open
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review tier: Lite
Findings: 1
New issues introduced by this change (1)
| Severity | Finding |
|---|---|
 |
CONTRIBUTING.md — This section says the clone retains the main branch history, but the command clones whatever the… |
What changed in this PR
Adds contributor-facing guidance to reduce clone size/transfer by avoiding generated dashboard branch history, and clarifies the tradeoff between full-history vs shallow clones.
Changes:
- Document a blobless, single-branch clone approach intended for contributors who need
mainhistory. - Document a shallow, single-branch clone option intended for CI or read-only scenarios.
- Explain that shallow clones omit older
mainhistory.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds a “Cloning efficiently” section describing recommended clone options and their history/size tradeoffs. |
Suppressed comments (1)
CONTRIBUTING.md:27
- This section references the latest
mainsnapshot, but the command clones whichever branch is the repository default. Consider specifying--branch mainexplicitly so CI/read-only guidance stays correct if the default branch changes.
git clone --depth=1 --single-branch https://github.com/dotnet/skills.git
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| contributor clone that retains the `main` branch history, use: | ||
|
|
||
| ```bash | ||
| git clone --filter=blob:none --single-branch https://github.com/dotnet/skills.git |
7 tasks
Contributor
|
👋 @jamesmontemagno — this PR has 1 unresolved review thread(s). When you're ready, please address the feedback and push an update; the triage bot will pick up the next state automatically. (Add the |
This file contains hidden or 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
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.
Summary
mainhistoryThis helps users avoid downloading disconnected generated dashboard branch history without changing repository behavior or expanding the focused Actions change in #1089.
Validation
npx --yes markdownlint-cli2 CONTRIBUTING.md