Open kinow opened 5 years ago
Based on the conversation on #64 (and to keep things in the correct context):
One question I have: would it make sense to have templates for the most common project types that can be created for cylc ?
As a generic, base name (as @kinow proposed on #64), cylc-project-template looks fine.
One question I have: would it make sense to have templates for the most common project types that can be created for cylc ?
Good question, cc @cylc/core. As we don't have much development bandwidth while working on Cylc 8 (scheduled for mid 2020 I think), I think a single repo with the generic contents for all projects would be easier. But wouldn't veto multiple templates 👍
As a generic, base name (as @kinow proposed on #64), cylc-project-template looks fine.
In that case I think we would have:
cylc/cylc-project-template
with
LICENSE
or COPYING
file, with the GPL-3 licenseREADME.md
with badges and the sections without content, except for the contributing and license partsCONTRIBUTING.md
with the CLA and contribution guidelinesCHANGES.md
with the 0.1 version and empty sections.github
with issues and PR templatessetup.py
(for JS projects we can simply remove it).pre-commit-config.yaml
for the pre-commit hooks.travis.yml
as well I thinkSounds good to me, with @kinow's tweaks :+1:
Agreed, the template content looks fine.
Depending on the hooks list, there might be some additional configuration files like .flake8 for example.
GitHub provides project templates: https://help.github.com/en/articles/creating-a-template-repository
Would be nice to get one for Cylc, as we may end up getting more projects later. It could come with:
CHANGES.md
templateCONTRIBUTING.md
LICENSE
orCOPYING
setup.py
(even if not Python, I think it's fair as that's the most common language).github/
and templates