gentzkow / GentzkowLabTemplate

MIT License
0 stars 2 forks source link

Make Git LFS optional in examples #22

Open lucamlouzada opened 4 days ago

lucamlouzada commented 4 days ago

This issue is part of an effort to implement substantive improvements to the lab template, as discussed in https://github.com/gentzkow/GentzkowLabTemplate/issues/16.

In this issue, the goal is to work on how to robustly require Git LFS and also create an easy option for people who want to use the repo without Git LFS. The main points to be addressed per the decision in plans for next steps are:

  1. The template can run out of the box without Git LFS installed and it functions correctly as a template on Github. This means we need to revise the way we currently commit data and figure files into non Git LFS.
  2. The template is preconfigured so that someone who does want to use LFS can do so easily.
  3. We have good ways of enforcing that all of our lab projects must be using LFS.

I am assigning myself to work on this. I will start by revising the commits of large files in the template examples, and changing the gitattributes file as well as the check_setup.sh file to allow users to use the template without Git LFS. I will then create an additional folder in examples with the default settings for using Git LFS, which will be standard in the lab projects. I will run tests to ensure both points (2) and (3) above are enforced.

lucamlouzada commented 4 days ago

I have pushed several changes to this branch.