Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
May 30, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/schema/rules/checks/hints.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down