search

veltman / clmystery

A command-line murder mystery
Other
5.67k stars 1.27k forks source link

The .zip file is redundant #4

Closed rikusalminen closed 10 years ago

rikusalminen commented 10 years ago

Including the .zip file of the entire repository in the repository itself is not a good practice. If the project history would extend further, the size of the repository history would rapidly grow. Over time, it would become also become nuisance to maintain (although a git pre-commit hook could be used to automate it), especially to outside contributors.

Consider removing the .zip file from the repo.

GitHub already offers the ability to download .zip files so it's not needed to support people that don't like or know git. Like this: https://github.com/veltman/clmystery/archive/master.zip

There is a download link to that zipball in the side bar in the repository view.

mcscope commented 10 years ago

Working on a PR for this

veltman commented 10 years ago

Fixed this. Thanks!

mcscope commented 10 years ago

Doh! looks like you beat me to it... https://github.com/veltman/clmystery/pull/6

rikusalminen commented 10 years ago

Ok, good.

You should also consider whether the same applies to cheatsheet.md/cheatsheet.pdf. In general, it's not a good idea to have generated files (object files, executables, etc) in a repository and even more so when using Git. If there are some files that have to be generated (e.g. the .pdf file), you should consider automating the process.

The problem is that when a contributor wants to make the change to the source file (cheatsheet.md), they will also have to update the target file (cheatsheet.pdf) manually. And the repository size may grow (rapidly) because small changes might make big diffs in Git.

Git is just not a very good tool for storing binary files because it was not designed for that.