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
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
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: