Giter Site home page Giter Site logo

Create project template about cylc-admin HOT 4 OPEN

kinow avatar kinow commented on June 30, 2024
Create project template

from cylc-admin.

Comments (4)

sgaist avatar sgaist commented on June 30, 2024 2

Agreed, the template content looks fine.

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

from cylc-admin.

sgaist avatar sgaist commented on June 30, 2024

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.

from cylc-admin.

kinow avatar kinow commented on June 30, 2024

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

from cylc-admin.

hjoliver avatar hjoliver commented on June 30, 2024

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

from cylc-admin.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.