Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Update Contribution guide how to clone the repo faster

Damian Legawiecbe88d52f38a1
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 954ec58693..28cf977686 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,5 +1,13 @@
# Contributing
+## Cloning the repository
+
+Spree is a big monorepo. For a faster clone, use a **partial clone** which downloads file contents on demand while keeping full commit history for `git log` and `git blame`:
+
+```bash
+git clone --filter=blob:none https://github.com/spree/spree.git
+```
+
## Spree codebase
Spree is a monorepo with two main areas:
diff --git a/docs/developer/contributing/developing-spree.mdx b/docs/developer/contributing/developing-spree.mdx
index 5f70cb4e2e..cde7d23c1f 100644
--- a/docs/developer/contributing/developing-spree.mdx
+++ b/docs/developer/contributing/developing-spree.mdx
@@ -5,6 +5,14 @@ description: >-
code. We're happy you're here!
---
+## Cloning the repository
+
+Spree is a big monorepo. For a faster clone, use a **partial clone** which downloads file contents on demand while keeping full commit history for `git log` and `git blame`:
+
+ ```bash
+ git clone --filter=blob:none https://github.com/spree/spree.git
+ ```
+
## Spree codebase
Spree is a monorepo with two main areas: