github / git-sizer

Compute various size metrics for a Git repository, flagging those that might cause problems
MIT License
3.48k stars 139 forks source link

Add suggestion on how to resolve spotted issues #69

Open ykoehler opened 3 years ago

ykoehler commented 3 years ago

As an example, when the biggest blob is found, git-sizer could suggest how to remove it. There is a tool out there named git-forget-blob which could be used to solve the issue if the blob is to be found to be a mistake.

For example in our case, someone had committed/pushed a cscope.out in their own branch.

When there are possible solution like this, providing a "suggestion" on how to proceed next, would be awesome.

mhagger commented 3 years ago

It's an interesting idea. I don't think I'd want git-sizer itself to try to explain possible next steps, since they can be pretty complicated and also have implications like invalidating signed tags and SHA-1s in issue comments that we'd want to make users aware of. But I can imagine git-sizer outputting links to longer-form articles or maybe to the instructions that go along with tools like git-filter-branch or BFG that they might want to use.