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

Update main readme with more informative template #142

Open
8 tasks
georgerichardson opened this issue Sep 7, 2022 · 0 comments · May be fixed by #143
Open
8 tasks

Update main readme with more informative template #142

georgerichardson opened this issue Sep 7, 2022 · 0 comments · May be fixed by #143
Assignees
Labels
enhancement New feature or request

Comments

@georgerichardson
Copy link
Contributor

The current readme project root directory readme specifies minimal installation instructions and some other information. The lack of guidelines or a template lowers expectations and creates an overhead to creating good readmes. This is leaving us with projects that have incomplete or uninformative readmes. This will add:

  • Project name
  • Description of project
  • A nice picture or graphic
  • Outline of the components of the project
  • Guide for where to find parts of the pipeline and analysis
  • Link to other resource (e.g. slide deck of results)
  • Installation instructions
  • Who to reach out to with questions
@georgerichardson georgerichardson self-assigned this Sep 7, 2022
@georgerichardson georgerichardson added the enhancement New feature or request label Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant