Skip to content

Update sparse checkout instructions to use a fork #2588

Open
@mdavis-xyz

Description

@mdavis-xyz

The tips include instructions on how to do a sparse checkout. However this is how to do a checkout of typst/packages as the origin remote. Unless I'm mistaken, that's actually not a useful thing to do. What you typically want to do as a contributor is fork the repo, clone that sparsely (typically as origin), and also add typst/packages as another origin (typically upstream). If you do forget to set both of those remotes as sparse checkouts, then when you push a commit, it will download everything. So the sparse thing won't work.

I propose changing the sparse checkout code snippet to:

git clone --depth 1 --no-checkout --filter="tree:0" [email protected]:{your-github-username}/packages
cd packages
git sparse-checkout init
git sparse-checkout set packages/preview/{your-package-name}
git remote add upstream [email protected]:typst/packages
git config remote.upstream.partialclonefilter tree:0
git sparse-checkout reapply

(I'm not sure if all those steps are necessary.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions