feat(schema): Add schema check for README file (bids-standard#1841)

markmikkelsen · May 30, 2024 · 898ea86 · 898ea86
1 parent bde703a
commit 898ea86
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/src/schema/rules/checks/hints.yaml b/src/schema/rules/checks/hints.yaml
@@ -4,6 +4,21 @@
 
 ### Dataset level
 
+# 101
+# This check should probably be replaced by making sure rules.files.common.core.README is
+# hit, but this is the short path forward.
+ReadmeFileMissing:
+  issue:
+    code: README_FILE_MISSING
+    message: |
+      The recommended file /README is missing.
+      See Section 03 (Modality agnostic files) of the BIDS specification.
+    level: warning
+  selectors:
+    - path == '/dataset_description.json'
+  checks:
+    - exists(["/README", "/README.txt", "/README.md", "/README.rst"], "dataset") > 0
+
 # 102
 TooFewAuthors:
   issue: