search

bids-standard / bids-validator

Validator for the Brain Imaging Data Structure
https://bids-standard.github.io/bids-validator/
MIT License
1 stars 4 forks source link

validate CHANGES file to follow CPAN Changes convention #61

Open sappelhoff opened 4 years ago

sappelhoff commented 4 years ago

The CHANGES file MUST follow CPAN Changes convention, see: https://bids-specification.readthedocs.io/en/latest/03-modality-agnostic-files.html#changes

The validator should check the CHANGES file and warn or raise an error when no CPAN Changes convention is detected.

A validator is already available here: https://metacpan.org/pod/Test::CPAN::Changes

sappelhoff commented 4 years ago

@rwblair if somebody wanted to make a PR for this issue, are there some caveats with regards to how they can open and read a file?

E.g., in Python I would do:

# Read the file
with open("CHANGES", "r") as fin:
    content = fin.readlines()

# Now validate the content
pass

But I suspect that this is different because the bids-validator needs to work on command line AND browser (and browsers tend to have a screwy file API?)