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.

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

Conversation

effigies
Copy link
Collaborator

Restores issue README_FILE_MISSING to the schema-based validator.

@effigies effigies added schema Issues related to the YAML schema representation of the specification. Patch version release. exclude-from-changelog This item will not feature in the automatically generated changelog labels May 30, 2024
@effigies effigies requested a review from rwblair May 30, 2024 20:56
Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.04%. Comparing base (bde703a) to head (11e7438).
Report is 259 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1841   +/-   ##
=======================================
  Coverage   88.04%   88.04%           
=======================================
  Files          16       16           
  Lines        1380     1380           
=======================================
  Hits         1215     1215           
  Misses        165      165           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@rwblair rwblair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could throw an error/warning if that length is more than 1:

A BIDS dataset MUST NOT contain more than one README file (with or without extension) at its root directory.

Not sure if that has ever happened, anyone cares if it does happen, or if the legacy validator currently checks for it. Happy to merge with or without.

@effigies effigies merged commit 898ea86 into bids-standard:master May 30, 2024
28 checks passed
@effigies effigies deleted the schema/missing_readme branch May 31, 2024 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude-from-changelog This item will not feature in the automatically generated changelog schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants