You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
I agree that a skeleton for a README is a good idea, just to make sure the same basic information can be found in each repo. You can also provide a place in that template where extra information can be put, below the essentials, to keep things overseeable.
My experience with cookiecutter templates for Python projects is not very positive. I've elaborated on this in #5.
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
The text was updated successfully, but these errors were encountered: