Adding WDL and Docker Contribution Guides #23
Conversation
|
@sitapriyamoorthi -- I pushed some updates to address your comments on the WDL Config file, would you mind taking a look one more time? |
There was a problem hiding this comment.
This looks great to me.
Here are some best practices in "Developing WDL Workflows" that we are preaching that you might want to consider to incorporate: (mostly in "The first task" )
-
We prefer "heredoc" syntax in the Command section.
-
We put quotation marks around a String or File variables in Commands.
-
We recommend file localization (might be less important as this is an issue we see in miniWDL).
-
We specify in more detail what Runtime attributes are needed for each backend, and what FH HPC needs and what it will ignore. See our appendix.
|
Great call, @caalo, thanks for catching that! Just added a few bulletpoints to the Stylistic Guidelines section to address that and added a couple more links out to the WDL101 course in case people want to learn more. |
As the WILDS WDL pipelines prepare to make their debut in a week and a half, we need guidelines around how WDL's and their corresponding Docker images should be designed. This pull request adds initial versions for each set of guidelines and incorporates them into the overarching WILDS Contribution Guide after the "Package Maintenance" section but before the "Security" section. The location of these guides is definitely flexible, just wanted to get an initial version out there and we can move it as needed in the future. These are definitely first drafts, so if you'd like to add/remove guidelines or you feel that something's misworded/misarranged, please feel free to suggest those changes. Thanks for your input! Really appreciate it! #IntoTheWildsWeGo 🐺