Do not ignore the README.md files in raw_data, processed_data, and re…

…sults.
fmi-faim · Jun 6, 2024 · 5da4f72 · 5da4f72
1 parent 206df39
commit 5da4f72
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/template/.gitignore b/template/.gitignore
@@ -219,8 +219,11 @@ infrastructure/apps/**/
 
 # Data directories
 processed_data/**
+!processed_data/README.md
 raw_data/**
+!raw_data/README.md
 results/**
+!results/README.md
 
 # TMP
 infrastructure/.tmp_*/**
diff --git a/template/processed_data/README.md b/template/processed_data/README.md
@@ -0,0 +1,4 @@
+# Processed Data
+This directory contains processed data, which is derived from your raw data.
+
+__Note:__ This directory is not tracked by git.
diff --git a/template/raw_data/README.md b/template/raw_data/README.md
@@ -0,0 +1,4 @@
+# Raw Data
+This directory contains your raw data.
+
+__Note:__ This directory is not tracked by git.
diff --git a/template/results/README.md b/template/results/README.md
@@ -0,0 +1,4 @@
+# Results
+Finale results (e.g. plots and figures) are stored here.
+
+__Note:__ This directory is not tracked by git.