diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73557ffee0..fd478d7824 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,28 @@ This repository contains shared building blocks for coding agents: Because these artifacts can affect many users and workflows, we prioritize correctness, clarity, and long term maintainability over speed. +## Cloning efficiently + +This repository has generated dashboard branches with substantial history. For a +contributor clone that retains the `main` branch history, use: + +```bash +git clone --branch main --filter=blob:none --single-branch https://github.com/dotnet/skills.git +``` + +`--single-branch` excludes the disconnected generated branches, while +`--filter=blob:none` avoids downloading historical file contents until needed; +files required for the initial checkout are still downloaded. + +For CI or read-only use that needs only the latest `main` snapshot, use: + +```bash +git clone --branch main --depth=1 --single-branch https://github.com/dotnet/skills.git +``` + +The shallow option omits older `main` history, so it is not recommended when that +history is needed for development. + ## Code ownership Every plugin, skill, and agent must have designated owners in the `.github/CODEOWNERS` file. When you add a new skill or agent, add a matching CODEOWNERS entry. Ownership must be either: