git-novice icon indicating copy to clipboard operation
git-novice copied to clipboard

Suggestions on git large file system and submodule

Open sunyi000 opened this issue 5 years ago • 1 comments

I would like to make the following 2 suggestions

  1. in episode 10 https://github.com/swcarpentry/git-novice/blob/gh-pages/_episodes/10-open.md it mentioned a little on Git LFS. I think it should also mention that the recommended size of a repository is < 1Gb. Git should be used for source code, not as a storage solutions. Storing graphical/binary assets in git is not a good idea and should not be encouraged.

  2. Maybe worth adding a section/episode on 'git submodule'. It is useful when a project depends on another one in a separate repository.

sunyi000 avatar Nov 13 '19 15:11 sunyi000

Hi @sunyi000,

  1. git should absolutely be used for source code, and not storage solutions. However, for things like test data git LFS can be extremely helpful. I don't think this particular solution is "encouraging" our learners to store data in git. That said, I think it would be a helpful addition to this particular exercise to add a sentence talking about best practices for repositories (including not tracking datafiles).

  2. I think 'git submodule' is far outside of the scope of the git-novice lesson, but certainly could be included in an intermediate or advanced lesson.

munkm avatar Dec 10 '19 21:12 munkm