CLOSE REVIEWHow should README and CHANGELOG files be used to document your project?
(Student response here)
Did you like this question?
Instructor solution
The Readme contains a description of the project details, like dates, researcher names and contact information, subject demographics, directory organization, naming conventions, processing pipelines (including software and hardware versions) etc.
The Changelog records a history of notable changes, especially corrections and reorganization.
Don't use proprietary commercial products (like Microsoft Word) to save the README or CHANGELOG, because you can't be sure it'll be readable in the future or on every operating system. Instead, use text or markdown formats.
Was this helpful?
Think you've got it?
If I find an error in one of my datasets and need to fix it manually, where should I report that information?
- A.
CHANGELOG
- B.
README
Was this helpful?
You may exit out of this review and return later without penalty.