/README-guidelines

README guidelines for MEDS (and beyond)

Primary LanguageHTML

MEDS README Guidelines

General guidelines and best practices for writing informative READMEs.

Description

These README guidelines are emphasized in EDS 296 - Data Science Tools for Building Professional Online Portfolios, but are meant to be reinforced throughout the MEDS program.

Contributers

These guidelines were drafted by MEDS staff and faculty Sam Csik, Julien Brun, Carmen Galaz Garcia, Ruth Oliver, and Max Czapanskiy, and draw from personal experiences and existing recommendations / standards which are widely adopted by the data science and programming communities.