Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorial template #111

Closed
uekerman opened this issue Oct 25, 2020 · 4 comments
Closed

Add tutorial template #111

uekerman opened this issue Oct 25, 2020 · 4 comments

Comments

@uekerman
Copy link
Member

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?

@MakisH
Copy link
Member

MakisH commented Oct 26, 2020

I definitely aggree that we need this!

Regarding Allclean and .gitignore, see also the related issues #88 and #87, respectively.

Regarding the location, top-level is good. Related issue there: #28.

@IshaanDesai
Copy link
Member

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.

@MakisH
Copy link
Member

MakisH commented Oct 30, 2020

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.

@MakisH
Copy link
Member

MakisH commented Apr 12, 2021

Let's not add a template, only extensive contributing guidelines.

@MakisH MakisH closed this as completed Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants