search

tom-doerr / vim_codex

Supercharge your Vim editor with AI-powered code completion using OpenAI Codex. Boost productivity and save time with intelligent suggestions.
MIT License
258 stars 28 forks source link

Consider removing the screenshot / gifs from the main repository #16

Closed oddlama closed 1 year ago

oddlama commented 1 year ago

By including the screenshot / gif in your main repository, every user will have a copy of these gigantic files for no reason at all, when all they need is the few kilobytes of vimscript / python. Unfortunately a lot of plugins do this and it unnecessarily bloats the whole vim installation.

A much easier and better alternative is to use a permalink generated by github for these files and use that link in the repo instead. You can generate such a link by simply dropping the file into a new github issue. Even if you discard the issue afterwards, the genereated link will be a permalink to the uploaded file on github's servers.

Most plugin managers do shallow clones (--depth 1) by default, so changing this now will still benefit all users, as history isn't kept when updating.

tom-doerr commented 1 year ago

Hi @oddlama, thanks for opening the issue. Yes, that is a lot of unnecessary data, for my newer projects I added links instead of adding GIFs to the repo itself, I did not know that I can upload files into issues and link to them. PRs are welcome ;)