README files should be made in a plain text format.Reviews Three times Apple AppStore App of the Year. Use a README to include changes made over time. README files should include contact points and names of maintainers, date, brief description of the intent of the project, and the source of any data files. Best Plus history of all changes to the project, checksumsĪll projects should include a README file in the top directory.Better Date, name, contact info, short summary, Markdown.Placed raw data in gapminderDataFiveYear_superDirty.xlsx file in 01_cleaning and # Summary of gapminderDataFiveYear_superDirty.xlsx from Frank Grimes. Many countries spanning the last several decades. The dataset reflects population-level statistics about This data is the gapminder dataset, originally collected and published in XXX,Īnd retrieved from. This project analyzes population-level statistics about many countries toĭetermine if there is a relationship between x and y. These are for our benefit, not the computer. So another good practice is to use good, descriptive names on files, directories, and in code. Later never comes, or we forget the details by the time it does. We’ve all had projects under a deadline or someone asking for a result, and the documentation step is easy to defer until later. READMEs are commentary on what we consider the “real work”, and realistically can be an afterthought.
0 Comments
Leave a Reply. |