Skip to content

Commit 50418bb

Browse files
committed
docs(workflow): document sparse-index guardrail
1 parent 420a5a0 commit 50418bb

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/LOCAL_WORKFLOW.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,23 @@ Before an import:
3131
are ignored.
3232
- `.claude/archive/` contains local historical work notes and is ignored.
3333
- Python caches (`.pytest_cache`, `.mypy_cache`, `.ruff_cache`) are disposable.
34+
35+
## Large-repository guardrail
36+
37+
The default sparse checkout intentionally leaves `data/` and `site/` out of
38+
the working tree. Do not copy a large shard or generated dump back under this
39+
repository just for local inspection: that makes Git expand the sparse index
40+
on routine status checks.
41+
42+
If Git reports that the sparse index is expanding, preserve the local artifact
43+
in a sibling folder outside the repository, then reapply the documented
44+
checkout:
45+
46+
```
47+
git sparse-checkout reapply --sparse-index
48+
git config core.fsmonitor true
49+
git fsmonitor--daemon start
50+
```
51+
52+
This keeps normal `git status` work proportional to changed files. Never use
53+
`assume-unchanged` or `skip-worktree` to mask an import or generated dump.

0 commit comments

Comments
 (0)