Skip to content

Having a README.md template for all repos of QC-Devs #10

@FanwangM

Description

@FanwangM

We have many repos in theochem under the umbrella of QC-Devs. But when it comes to README.md files, every repo has its own style and content. I think it would be helpful to draft a template for everyone as a reference. Not every project should follow exactly the same format, but would be helpful to have a guideline for us to look at. I can draft one if you think this would be helpful.

In addition, do you think it would be useful to have a cookiecutter template (including the README.md) for everyone to use in the future so that people will not need to worry about setting up the GitHub Actions, website, etc. So that we can focus more on science instead of these factors, which can take time from people. Any comments would be appreciated. @PaulWAyers @FarnazH @tovrstra @marco-2023

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions