bertozzivill / malaria-atlas-project

0 stars 0 forks source link

Integrate Git/GH Best practices curriculum with data best practices curriculum #125

Closed bertozzivill closed 5 years ago

bertozzivill commented 5 years ago

https://wiki.idmod.org/display/ITP/7.+Data%3A+Best+Practices

https://github.com/InstituteforDiseaseModeling/idm-welcome/issues/1

bertozzivill commented 5 years ago

From Kevin:

Thanks! The Git intro is very nice as well. I need to learn how to utilize more of the cool wiki features to organize these – I like the tabbed content, and the external videos. I think the cardinal rule of no sensitive data in repos is the only strict rule that should (must) be followed. I think this rule is worth highlighting with the “red exclamation point” warning style in the wiki. As far as other best practices, I might add a couple of things: If the project code references data that’s not included in the repo, utilize the readme that Git creates by default to record what and where that data is, and who to contact if there are internal access restrictions. (More of a coding best practice than a git best practice, and also maybe more of a personal preference, but I’ll put it here anyway). I find it useful for project code to have a single, obvious place where a base path to all the needed data is defined, and for all other code to strictly access data relative to that base path. This way, a new user or the same user on a different machine needs only to define that base path locally, and everything else should run from there. More generally, I think it’s good Git/code practice to consider the next user who will clone this repo, and try to avoid any patterns that they would need to change before they could run the code from start to finish.