search

nuest / ten-simple-rules-dockerfiles

Ten Simple Rules for Writing Dockerfiles for Reproducible Data Science
https://doi.org/10.1371/journal.pcbi.1008316
Creative Commons Attribution 4.0 International
64 stars 15 forks source link

Updates by @vsoch #21

Closed vsoch closed 4 years ago

vsoch commented 5 years ago

This is a (work in progress) pull request to show progress on the draft. I'm going to first go through the bullets and then (if appropriate) write them into more human friendly sentences.

Signed-off-by: Vanessa Sochat vsochat@stanford.edu

vsoch commented 4 years ago

hey @nuest ! I'm all done with my changes, specifically I've taken all bullet points and flushed them out into full fledged lines (notice number of lines changed). As instructed, when a reference was needed I added a link or REF. This should be ready to merge, I won't be doing any further work on it, at least until there is a more finalized draft to look at.

I generally maintained all rules / structure, with the exception of Rule 8 (add the build/run to comments at end) which was redundant from a previous rule to suggest using comments for transparency, etc. What I did is move content from there into that issue, and modified rule 8 to be about creating a protocol for starting a new project (which was missing and I think important).

Please merge and tweak to your needs! I'm moving cross country in the next two weeks plus a conference, so I wanted to get this finished for you today. Cheers!

vsoch commented 4 years ago

ping @nuest - did you see this?

nuest commented 4 years ago

Yes @vsoch - thank you for the reminder! A deadline took control of my last two weeks, and I am traveling now, but will take a look at it by the end of the week. I can already say: Wow! :open_mouth:

There's also plenty of discussion issues to follow up on - this manuscript is my reward for the other submitted one ;-) and I look forward to reading your work.

nuest commented 4 years ago

Hi Vanessa - thanks for pushing the manuscript a huge step forward!

I'm working through your changes now, will create a new PR for you and the others to take a look at soon.

nuest commented 4 years ago

Sorry, I just realised that my pushes go of course directly to master. So, first changes after this PR are in https://github.com/nuest/ten-simple-rules-dockerfiles/commit/4a87e3e3ad43feacd98722f1521e500191bb17bb - will update here tomorrow with more.