Software Version Control

Exercise: Which of the following do you think should be part of a code repository (5-10 mins)

Discuss with your neighbor which of the following should be part of the code repository and why it should or should not.

  • installation instructions (i.e. detailed instructions on how to install the software)
  • user documentation (i.e. information for the users of the software about its functionality and features)
  • full dataset to reproduce figures from a paper
  • a few data files to test the functionality of the code base
  • in-line comments intended only for code developers