Changelog Best Practices

Describes Use and Best Practices for READ ME files

Also often titled a "README" file, this text tile serves as a project folder much like a table of contents of a book or a report. It outlines what you will find inside and provides a space for noting changes in the contents.

Some basic elements of this text file may include:

• Project title--add your project title at the top of the text file

• Contact information--include name, and contact information

• Overview--include what files will be found in the project archive and descriptions of the information in the files

• Instructions--include details on how the files should be used together

• Change Log--notes on any additions, subtractions, or corrections made to the associated files

Updated August 2022