search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
4 stars 4 forks source link

Mention of design principles #49

Open joshwlambert opened 1 year ago

joshwlambert commented 1 year ago

Recently it was mentioned that the Epiverse-TRACE blueprints are more focused on process than on design. For a lot of the discussions we've had around design have referred back to the Tidyverse design guide.

Is it worth adding a chapter (or just a few sentences) to blueprints, similar to the Code review chapter, that states we work in accordance with the design principles laid out by the Tidyverse and then mention any differences? Or perhaps design is outside the scope of blueprints.

Would be good to hear people's thoughts on this.

pratikunterwegs commented 1 year ago

I agree - and I think we could go a bit further and add some design principles as well. My understanding is that we do espouse principles such as small self-contained packages, shared classes and general interoperability, modular package organisation, or user-friendliness. Speaking for {epidemics}, I think composability and modularity are fairly central with user-friendliness as the motivating goal. Perhaps these are more related to process, but they seem like design principles to me.