remove /images directory from repo to avoid encouraging people to add images to repos!

dwyl / learn-travis

:sunglasses: A quick Travis CI (Continuous Integration) Tutorial for Node.js developers

MIT License

1.25k stars 352 forks source link

remove /images directory from repo to avoid encouraging people to add images to repos! #24

Closed nelsonic closed 6 years ago

nelsonic commented 6 years ago

At present there is an /images directory in the project: https://github.com/dwyl/learn-travis/tree/a597ff014c145bd16e3827294b1cd9d8c9c86a73/images

I used to think that storing the image file (binary) in the repository was a good way of including images in a README.md ... I was wrong. The most effective way is to upload the image to GitHub's CDN and then include a link to it in the markdown.

nelsonic commented 6 years ago

Fl4m3Ph03n1x commented 6 years ago

Why do we want to keep people from adding images? I mean, a good schematic is always nice, right?

nelsonic commented 6 years ago

@Fl4m3Ph03n1x perhaps I did not make this clear. I agree that images are a great form of communication. There is no advantage to bloating a git/GitHub repository with images because their binary nature is not easy to track changes as text.