You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It could be helpful to have a tutorials template to copy from for new tutorials.
For contributors as they then have to do less.
For maintainers as contributors are nudged towards consistency.
Such a template could include:
a README.md with things are readme should / could include
an INSTRUCTIONS.md with all you have to do if you contribute a tutorial. The contributor should finally delete this file
a precice-config.xml with some different variants in there. Whatever you don't need, you can delete
an Allclean script, if there is no global one?
a gitignore if there is no global one
an Allrun script with different options in there again
Could be placed directly on the top level.
* CHT
* FSI
* template
Opinions on this?
The text was updated successfully, but these errors were encountered:
If Allrun and Allclean scripts are provided in the template would it be assumed that the folder structure is also part of the template? The folder structure itself can be finalised then.
A possible far-future concern would be: when we have tutorials with more than two participants and with participants other than Fluid/ and Solid/. At that point the template can be generalized further.
We already have tutorials with more than two participants (and often special steps), so I am not so sure about Allrun. But Allclean we can write in a rather general way.
It could be helpful to have a tutorials template to copy from for new tutorials.
For contributors as they then have to do less.
For maintainers as contributors are nudged towards consistency.
Such a template could include:
README.md
with things are readme should / could includeINSTRUCTIONS.md
with all you have to do if you contribute a tutorial. The contributor should finally delete this fileprecice-config.xml
with some different variants in there. Whatever you don't need, you can deleteAllclean
script, if there is no global one?gitignore
if there is no global oneAllrun
script with different options in there againCould be placed directly on the top level.
Opinions on this?
The text was updated successfully, but these errors were encountered: