Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 715 Bytes

principles-for-naming-files.md

File metadata and controls

18 lines (14 loc) · 715 Bytes

Principles for naming files

I. Machine readable

Regex and globbing can be used to find out the wanted file

  1. Avoid spaces, punctions, accented characters, case sensivity
  2. "_" underscore used to delimit units of meta-data that will be used later
  3. "-" hyphen used to delimit words

II. Human readable

  1. Contain content info in name

III. Plays well with default ordering

  1. Put numeric first
  2. use ISO 8601 standard for the date, i.e. YYYY-MM-DD
  3. leftpad numbers with zeros

References

  1. http://www2.stat.duke.edu/~rcs46/lectures_2015/01-markdown-git/slides/naming-slides/naming-slides.pdf?utm_content=bufferbdc67&utm_medium=social&utm_source=twitter.com&utm_campaign=buffer