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

default readme in BIDS dataset after conversion #93

Open
Remi-Gau opened this issue Aug 8, 2022 · 2 comments
Open

default readme in BIDS dataset after conversion #93

Remi-Gau opened this issue Aug 8, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@Remi-Gau
Copy link
Contributor

Remi-Gau commented Aug 8, 2022

hey

We (BIDS maintainers) are trying to see if we can improve the quality of the average README in BIDS dataset. Those tend to be pretty thin and are missing some information we would like to see there even if it can be formalized "yet" into the BIDS specification.

Hoping to leverage the bids converters to help to do.

So I am going around the different BIDS converters repo to see if we can start improving the default README they put in a the BIDS dataset.

There is template that is provided in the BIDS starter kit: https://github.com/bids-standard/bids-starter-kit/blob/main/templates/README.MD

Some possible options:

  1. use this template is
  2. use a subset of it
  3. add a link to the template README
  4. something else (a mix of 2 and 3?)

What do you think? I can try to open a PR if you want.

Also let us know if you think that the template README in the starter kit could / should be improved .

Feel free to disregard if you are already using some version of the template README.

@dvm-shlee
Copy link
Member

Thank you for informing the update and your suggestion. We will adopt this feature as you suggested!

@dvm-shlee dvm-shlee added enhancement New feature or request documentation Improvements or additions to documentation labels Jul 1, 2023
@dvm-shlee dvm-shlee added this to the v0.4.0 release milestone Jul 1, 2023
@Remi-Gau
Copy link
Contributor Author

I can make a PR for this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants