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

[BEP quickstart guide] compiling FAQ / first steps to do #1999

Open
christinerogers opened this issue Dec 9, 2024 · 3 comments
Open

[BEP quickstart guide] compiling FAQ / first steps to do #1999

christinerogers opened this issue Dec 9, 2024 · 3 comments

Comments

@christinerogers
Copy link
Contributor

christinerogers commented Dec 9, 2024

This excellent summary from @Remi-Gau deserves to be highlighted somewhere linked from the Submission guide / starter kit / tutorial.

Maybe the when and how to start a BEP section gets renamed to BEP quickstart guide, and the below is given in a subpage linking to examples.

No need for a letter of intent.
Open an issue on the BIDS website where you mention these info for the BEP:

- number: 45 # 44 is the last so you are next
  title:
  link: # link to google doc or pull request
  content: # raw, derivatives, metadata
    -   raw
  leads:
  # MUST match given-names and family-names 
  # from the list of bids contributors (see the bids specification citation.cff)
  # BIDS maintainers can add you in there if needed
  -   given-names: ' '
      family-names: ' '
  # Can have as many as you want
  # -   given-names: ' '
  #     family-names: ' '
  status: Just opened. New contributors welcome.
  blocking: # anything blocking the development of the BEP. If not leave emtpy.
  google_doc_created: 
  pull_request_created: # leave empty for now
  pull_request_merged: # leave empty for now

Also something I'd like to start having for each BEP is a communication channel (discord, mattermost, slack...) - should probably be mentioned in the google doc of the BEP.

See here to see how other BEPs are 'described'.
https://github.com/bids-standard/bids-website/blob/main/data/beps/beps.yml

Originally posted by @Remi-Gau in #1675

@Remi-Gau
Copy link
Collaborator

I can try creating a github issue form for this actually.

@christinerogers
Copy link
Contributor Author

christinerogers commented Dec 10, 2024

oh super.
The Submission page should also link back to the when and how section

The larger question of providing examples (like remi's excellent post) is still relevant --:
I just got questions yesterday on this process like "do i literally just fork the repo and make a branch and push it?" so spelling that out somewhere is not a bad is not a bad idea. Pointing to a model would be great too.

@christinerogers christinerogers changed the title [lowering barriers] FAQ : add this in a cheat sheet / faq if possible. [BEP quickstart guide] compiling FAQ / first steps to do Dec 10, 2024
@Remi-Gau
Copy link
Collaborator

I think the BEP process pages will go through a complete overall anyway

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants