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

Create project template #63

Open
kinow opened this issue Oct 8, 2019 · 4 comments
Open

Create project template #63

kinow opened this issue Oct 8, 2019 · 4 comments

Comments

@kinow
Copy link
Member

kinow commented Oct 8, 2019

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 template
  • CONTRIBUTING.md
  • LICENSE or COPYING
  • setup.py (even if not Python, I think it's fair as that's the most common language)
  • .github/ and templates
@sgaist
Copy link

sgaist commented Oct 13, 2019

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.

@kinow
Copy link
Member Author

kinow commented Oct 13, 2019

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:

  • a new repository cylc/cylc-project-template with
    • LICENSE or COPYING file, with the GPL-3 license
    • README.md with badges and the sections without content, except for the contributing and license parts
    • CONTRIBUTING.md with the CLA and contribution guidelines
    • CHANGES.md with the 0.1 version and empty sections
    • .github with issues and PR templates
    • setup.py (for JS projects we can simply remove it)
    • .pre-commit-config.yaml for the pre-commit hooks
    • Maybe a .travis.yml as well I think

@hjoliver
Copy link
Member

Sounds good to me, with @kinow's tweaks 👍

@sgaist
Copy link

sgaist commented Jan 12, 2020

Agreed, the template content looks fine.

Depending on the hooks list, there might be some additional configuration files like .flake8 for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants