Document efficient repository cloning - #1090
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.
|
👋 @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 |
|
I'm wondering if we'd want to move these dashboard branches off to another repo. I've been considering moving some of the test code over to another repo as well given how harnesses pull down the repo to load skills from plugins today. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Review tier: Lite
Findings: 1
Pre-existing issues (1)
| Severity | Finding |
|---|---|
CONTRIBUTING.md — This section says the clone retains the main branch history, but the command clones whatever the… View comment |
Suppressed comments (2)
Previously missed (1) — in code that hasn't changed since the last review.
CONTRIBUTING.md:22
--filter=blob:nonestill downloads the blobs needed for the initial checkout; it primarily avoids downloading historical blobs until they’re needed. The current wording can read as if no file contents are downloaded during the clone.
`--single-branch` excludes the disconnected generated branches, while
`--filter=blob:none` downloads file contents on demand.
CONTRIBUTING.md:18
- The text says this clone retains the
mainbranch history, but the command relies on whatever the repository’s default branch is. Making the branch explicit avoids confusion (and keeps this consistent with the shallow clone example below).
git clone --filter=blob:none --single-branch https://github.com/dotnet/skills.git
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Review tier: Lite
Findings: None
Issues resolved since last review (1)
| Severity | Finding |
|---|---|
CONTRIBUTING.md — This section says the clone retains the main branch history, but the command clones whatever the… View resolved comment |
|
@AbhitejJohn The review feedback is now fully addressed in commit I confirmed my account has triage/pull access but not push access to git fetch https://github.com/jamesmontemagno/skills.git motz-bookish-system
git push origin FETCH_HEAD:refs/heads/motz-bookish-systemGitHub cannot change an existing PR's head repository, so after the upstream branch exists we should open a replacement PR from |
|
✅ Evaluation passed for |
Btw. moving data to different repo will mean that action will need to have write token for that other repo. Though - not a new thing - as we already moved out the session logs. Would we move out the tests as well - then data can again live on a branch and above would not be a concerns. The contribution experience would suffer a bit + gating might get cumbersome. All that being said - moving just the data branches might be best as of now |

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