search

naobservatory / mgs-workflow

3 stars 2 forks source link

Institute a changelog? #9

Open mikemc opened 1 month ago

mikemc commented 1 month ago

I would find it helpful to have a list of changes as they affect me as a user of the pipeline output. An example is that in the newest runs, output is stored in "output/" rather than "output/results", and "hv_hits_putative_filtered.tsv.gz" is now gzipped. One way to do this is to start updating a NEWS.md file to record user-affecting changes (possibly it would make sense to start semantic versioning, but dates and/or short-hashes could do).

jeffkaufman commented 1 month ago

Another option would be to use code reviews. Will could make changes as PRs, and send them to you for review. This would have the additional benefit of you understanding more how the pipeline worked.

mikemc commented 1 month ago

Code reviews could separately be a good idea, but I still think having a plain-english summary of user-facing changes will be invaluable for anyone who wants to work with the results of the pipeline, and it will be easier for the person making the changes to at least draft these.

willbradshaw commented 1 week ago

I agree a changelog would be good. I don't think code reviews would substitute for this.