Skip to content

Commit

Permalink
schema: add check for duplicate READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Oct 11, 2024
1 parent 2e86e99 commit 0eb5aa7
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion src/schema/rules/checks/general.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ ReadmeFileSmall:
Please consider expanding it with additional information about the dataset.
level: warning
selectors:
- match(path, '^/README')
- match(path, '^/README.*')
checks:
- size > 150

DuplicateReadmes:
issues:
code: MULTIPLE_README_FILES
message: |
There are multiple '/README' files (with different extensions) in this BIDS
dataset. Only one '/README' file should exist.
level: error
selectors:
- match(path, '^/README.*')
checks:
- exists(["README", "README.md", "README.rst", "README.txt"], "dataset") == 1

0 comments on commit 0eb5aa7

Please sign in to comment.