Having a `README.md` template for all repos of QC-Devs
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 9
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing README.md files across the theochem repositories and the current GitHub Actions and website setup. Clarify whether the deliverable is a README.md guideline, a cookiecutter template, or both; the work is done when the proposed scope and reference template are agreed upon.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100