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

Jump to bottom

Allow file extensions for README #1431

Closed
mateuszpawlik opened this issue Mar 21, 2022 · 2 comments · Fixed by #1432
Closed

Allow file extensions for README #1431

mateuszpawlik opened this issue Mar 21, 2022 · 2 comments · Fixed by #1432
Labels
effort: low Estimated low effort task enhancement impact: high Estimated high impact task

Comments

@mateuszpawlik
Copy link

mateuszpawlik commented Mar 21, 2022 •
edited
Loading

The discussion started in bids-standard/bids-specification#972. We'd like to allow file extensions for the README file: .md, .rst, and .txt.

I've looked at the code but it's difficult for me to make a list of tasks.
@mateuszpawlik mateuszpawlik mentioned this issue Mar 21, 2022
Merged
4 tasks
@sappelhoff sappelhoff added enhancement effort: low Estimated low effort task impact: high Estimated high impact task labels Mar 21, 2022
rwblair added a commit that referenced this issue Mar 22, 2022
@rwblair
Allow .md .txt or .rst for README
90a1656 
fixes #1431 

If we seriously start expanding extensions for top level files these rules should be split out for clarity.
@rwblair rwblair mentioned this issue Mar 22, 2022
Merged
@mateuszpawlik
Copy link
Author

mateuszpawlik commented Jul 4, 2022 •
edited
Loading

I've just testes the version v1.9.4 which I thought would have the README file extensions implemented. However, I figured that the changes from #1432 may not be enough. The validator reports [WARN] The recommended file /README is missing. See Section 03 (Modality agnostic files) of the BIDS specification. (code: 101 - README_FILE_MISSING)

The check for README file has the filename hard-coded.

I can't reopen this issue and I'm not sure what's the process.

@sappelhoff
Copy link
Member

Thanks for the report, please open a new issue for this problem and then we can prepare a PR to close it :-)

@mateuszpawlik mateuszpawlik mentioned this issue Jul 4, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort: low Estimated low effort task enhancement impact: high Estimated high impact task
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow .md .txt or .rst for README bids-standard/legacy-validator
2 participants
@mateuszpawlik @sappelhoff