GenomicDataInfrastructure / standard-operating-procedures

A repository for managing standard operating procedure (SOP) resources for the GDI project.
GNU Affero General Public License v3.0
3 stars 1 forks source link

SOP creation sop #13

Closed M-casado closed 3 weeks ago

M-casado commented 2 months ago

Summary

Addition of the SOP to generate other SOP templates based on an SOP request.

Types of changes

Motivation and Context

This SOP aids the repository maintainers (OC/SDPC, T4.3...) to create SOP templates based on SOP requests.

References

https://github.com/GenomicDataInfrastructure/standard-operating-procedures/issues/9

Changes Introduced

Review

Not yet reviewed.

Additional Notes

NA

Checklist:

General Compliance:

Only applicable if the PR includes new, or changes to, GDI SOPs (i.e., documents at sops/):

M-casado commented 1 month ago

For a more convenient review, you can also leave comments that I'll resolve before merging at the Google Document here.

Notice that it's just a copy-paste of the current document as of now. There are format changes, as expected.

elisavettorstensson commented 1 month ago

I went through the Google document. It is well-written, and it is an excellent first draft of this document. Many procedures are described in this document that one must do in practice to realise if the provided description was good or not or if it needs to include something. There is also so much information that one needs time to understand and become familiar with all this. At that moment, we are talking much more on a theoretical base, and it seems that the description in this document is good. I made some minor recommendations about some things, which you can consider if you want to change.

M-casado commented 1 month ago

Thanks for the review, @elisavettorstensson :) I added/responded to your feedback now

bhendriksze commented 1 month ago

This document seems very complete, informative, and practical, offering valuable insights. It's clearly structured, making it easy to read and hopefully easy to follow.

M-casado commented 1 month ago

Thanks for your reviews, @bhendriksze & @mattiasstromberg

Regarding your comment, Mattias, I completely agree. I initially had in mind that the GH issue would be enough for discussion. Nevertheless, some other groups were creating an RFC pot, where Requests For Comments documents would be added. Based on Dylan's input, this is done for "substantial changes", and the SOPs fall into that.

Therefore I myself would be content with the GH issue alone, but we can at least make use of GH's linking features, by referencing discussions/issues in different repos.

jdylan commented 4 weeks ago

This is an excellent document.

Re RFCs - I can envisage some SOPs being 'substantial' but also some being minor. I would support the OC/SDPC detemerining that on a case by case basis, as these committees have all relevant actors from the Pillars/nodes included, if that helps reduce some of the administrative the documentation burden for the more simple SOPs? This would only require a decision box being added after the 'Is SOP request valid?' on the 'Yes' with 'Does this SOP represent a 'substantial' change?'.

I think 2 members of each committee should be nominated as initial reviewers so there is a clear responsibility for the review within the relevant committee - they would also be responsible for monitoring the procession of the SOP through the different steps. These could be assigned just after determining if the SOP is valid, or if it is a substantive change (if that is added).

Re MB review, I would allow MB to request an extension, but also to explicitly indicate that a veto will not be exercised which would terminate the review period immediately and allow the the SOP to proceed to Step 6.

M-casado commented 3 weeks ago

I'll add the changes, Dylan, in order: