I really like this! Some minor quibbles: s/throug/through/g
"Your additions or changes will be adequately tested" - is it particularly tricky to be more specific here about what you mean by "adequately"? Would "we aim for 100% coverage" make sense for your work, or are your writing code that is either difficult to test or where unit tests may offer good coverage but not test functionality very well? I like this: "Check user input, check data structure, and fail often but explicitely." (BTW s/explicitely/explicitly/g). This is related to the "robustness principle" [http://en.wikipedia.org/wiki/Robustness_principle] which says that systems should be liberal about what they accept and conservative in what they do. It might be good to add something about how to phrase error messages. Error messages are difficult to write and it is hard, when you are deep into writing the internals of a system, to remember what the user can reasonably be expected to know. Type-static functions - I don't use R, but is it possible to enforce this in some way? Or check for violations of this rule in a CI? Docstrings - s/Write som./Write some./g HTH, Sarah On Mon, Mar 9, 2015 at 4:53 PM, Timothée Poisot <[email protected]> wrote: > Hi list, > > I am writing a set of guidelines that we will use in projects for the lab, > both for outside collaborators but also to have a sane basis for our work. > > Here it is as a gist: https://gist.github.com/tpoisot/9beac414179518ad10c5 > > I would really appreciate any feedback on it. If this is something you use > in your group, does it works well? > > t > > -- > Timothée Poisot, PhD > > Professeur adjoint > Département des sciences biologiques > Université de Montréal > > phone : 514 343-7691 > web : http://poisotlab.io > twitter: @PoisotLab > > > _______________________________________________ > Discuss mailing list > [email protected] > http://lists.software-carpentry.org/mailman/listinfo/discuss_lists. > software-carpentry.org -- Dr. Sarah Mount, Senior Lecturer, University of Wolverhampton website: http://www.snim2.org/ twitter: @snim2
_______________________________________________ Discuss mailing list [email protected] http://lists.software-carpentry.org/mailman/listinfo/discuss_lists.software-carpentry.org
