eddatasci / unrollment_proj

The Unrollment Project: Exploring algorithmic bias in predicting bachelor's degree completion.
5 stars 0 forks source link

Tagging at project milestones #29

Open btskinner opened 4 years ago

btskinner commented 4 years ago

I've added a tag to the repo, v0.1.0, to mark our submission for an ASHE 2020 symposium.

With other projects, tagging has been very useful. For an example, I tag updates to my EDH7916 course website so that students and I have a record of all changes. For research projects, tagging helps me find the repo status associated with particular milestones: proposal submissions, working paper releases, publications, etc. IMO, this takes advantage of git's version control (i.e. no need to save paper_ashe.pdf, paper_journal.pdf, etc) and supports replicability.

Projects that use tags (and GitHub's associated Releases) often follow semantics such that v<1>.<2>.<3> translates to

This structure doesn't translate exactly to our work, but in general I suggest:

Because we are in the early stages, first tag is set as v0.1.0.

A couple of notes:

  1. We don't have to tag every commit --- just often enough that there are useful markers of our progress.
  2. This should be helpful and not just one more thing™ to do for this project

Thoughts? Concerns?