qmk / qmk/qmk_cli

[Feature Request] Use Shallow Clone for firmware

Open
#235 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
187
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Description

The firmware repository takes nearly a gigabyte in size.

This can be significantly reduced by using a shallow clone via setting a clone depth of either 1 (the last commit) or 100 (the last hundred commits)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the firmware repository clone entry point in the qmk_cli code and inspect how clone options are passed to Git. Run the existing firmware setup or clone workflow to establish its current behavior, then verify that a shallow clone uses the selected depth and reduces the checkout size without breaking subsequent operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
cli, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.