search

epiverse-trace / blueprints

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

Documentation of decisions made around each discussion #17

Closed jpavlich closed 1 year ago

jpavlich commented 2 years ago

What are the plans to document the results of each discussion in the issues section?

Since some of those discussions directly affect development, it would be nice to have a structured document that explains the adopted policies. Is this going to be part of the blueprints document? Should it be a separate one?

thibautjombart commented 2 years ago

Absolutely! The current plan is to expand the current blueprints into a book, where the first chapter is the current blueprints, giving an overall view of core principles, and then individual chapters will document decisions and provide guidelines/examples on how to implement them. Does it make sense?

jpavlich commented 2 years ago

Definitively. To settle down most of the decisions it would be good to create a draft of the documents and continue the discussions around them, at least for those decisions that have been more thoroughly discussed (e.g. branch & merge) . What do you think?

thibautjombart commented 2 years ago

Absolutely. @Bisaloo has taken the lead on this and is on leave until next week, but I think this is the way to go. Most discussions got busy and then lost momentum, which hopefully means the topic is mature for a first draft.

Bisaloo commented 1 year ago

The current process to avoid PR going stale while waiting for review is to co-design each new chapter during the weekly all-RSEs meetings. The notes are then minimally reformatted and the content is uploaded, as in #27