advise people to not include images (or other binary files) in git repos
- Dominant language
- No language data
- Stars
- 91
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Git is meant for source code and other (_text-based_) files that require version control.
Images and other binary files are _difficult_ for a human to review in a GitHub Pull Request and they end up taking up a lot of space in the git repository.
This means that when ever a person clones/pulls the code they have to _download_ many/huge files (_not just the code which is typically tiny by comparison_)
A project we have been working on included a few binary files and, because Git tracks those files _forever_, each time anyone attempts to download the repo it's _unnecessarily_ **_huge**_:

on a _slow-ish_ connection this `git pull` took 20mins ... 😢
> This is a _general_ `git` "_best practice_" to avoid _clogging_ up your Git repo with files that don't need to be under version control.
if we are trying to avoid _excluding_ people on slow internet, we _have_ to make this a rule.
Thankfully, with images it's _easy_ to simply drag-and-drop (_or paste_) the image into a github issue/pr comment and then copy-paste the resulting markdown into your text file. **#easy**
see: https://robinwinslow.uk/2013/06/11/dont-ever-commit-binary-files-to-git/
Contributor guide
Assessment
This issue has not been assessed yet.