neurolibre / template

Template repository for NeuroLibre preprint submissions.
GNU General Public License v3.0
1 stars 5 forks source link

One template per branch #4

Open ltetrel opened 2 years ago

ltetrel commented 2 years ago

Each branch can contain one template example. This helps centralize all templates in one place. Not sure to what extent it is possible to create a new repo based on template branches, or if it takes just the main branch.

emdupre commented 2 years ago

If we ask users to fork the template repo, it will come with all included branches and then they'll be able to select the one they want to work off of by e.g. cloning only the desired branch.

I'm not sure if the extra (potential) user confusion is worth the de-cluttering, IMHO. But definitely something to discuss !

ltetrel commented 2 years ago

thx for feedback @emdupre So I am also questioning how github can manage template branches using the github interface (green button "use this template").

Yes, we need anyway to work on the templates. For now we have one template for python: https://github.com/neurolibre/template. If we want one template per repo, then we need to rename it. Ideally I see few other templates like:

emdupre commented 2 years ago

Ah, thanks for clarifying ! From my read of the GitHub template docs, the behavior around branches is really to pull all branches or just the default one, with the UX encouraging the latter behavior.

So, if we wanted the user to pull from a specific, non-default branch, they'd need to first select "Include all branches" (e.g. here) and then follow the usual git checkout workflow.