Guidelines

Version Control

Project Structure

  • Relative vs. absolute path:
    • Prefer relative paths (../Data/01.csv) over absolute paths (/home/name/Projects/Title/Data/01.csv) when refering to files within other files of your project. This has the advantage of keeping your whole project ‘mobile’—not tied to a particular path on the filesystem and easily redistributable.
    • Some paths have to be absolute (i.e. /usr/bin/python etc.).
  • Keep an organized folder structure. This dependends on the type of project and choice of programming languages and build tools.

Naming

  • Do not use any of the symbols & * % $ £ [ ] { } ! @ / in the filename.
  • Try to standardize filenames so they contain the same type of information in the same places:
    • results-a-2017-10-06-1.csv or 2017-10-06-results-a-1.csv
    • Be consistent: use the same case Results-1, Results-2, … (not results-2)

References