-
Couldn't load subscription status.
- Fork 189
BIDS Extension Proposal (BEP) submission process
This document conveys the process for submitting a BEP to BIDS.
Starting place: This process assumes the BEP is ready to be opened as a pull request to the bids-specification repository under the bids-standard organization.
Submission deliverables:
- Extension proposal
- Extension of the
bids-validatorto support the BEP - Examples added to
bids-examples- These examples will be used to test the validator is working properly
Suggested deliverables:
- Preprint of the new extension (if applicable)
- Press release for the
bids-websitenews section
Giving collaborators additional permissions within our bids-standard organization
Please ensure there is a BEP team already created under the bids-standard GitHub organization. If not, please contact one of our Maintainers (see list in DECISION_MAKING.md). A Maintainer will also help invite your fellow BEP members to the GitHub team and make sure your team has elevated permissions for your BEP.
Submitting the extension proposal
- Please create a new branch off of the
bids-specificationrepository - Please name the branch following the convention: bepxxx (e.g. bep003)
- Please label your PR’s with your bep tag. This will signal to the community which PR’s are for the specification or associated with a specific BEP
- When the branch is ready to be merged, please open a pull request against the
masterbranch to signal the BEP is ready for final reviews. We ask your initial pull request to themasterbranch is clean of comments and has one commit - adding your extension to the specification. Please let our Maintainers know if you need assistance squashing your commits.
The BEP lead will work with the Maintainers Group to coordinate the community review period.
Submitting the validator extension
- Please create a new branch off of the
bids-validatorrepository - Please name the branch following the convention: bepxxx (e.g. bep003)
- Please label your PR’s with your bep tag. This will clearly differentiate your work from those of the master branch. One may consider opening the pull request early to begin getting feedback. Please tag Ross Blair (@rwblair) in this PR. Please make sure to have a
[WIP]in the title of the pull request to indicate it is a work in progress. - When the validator is ready to be evaluated, please remove the
[WIP]from the pull request title and tag Ross Blair (@rwblair)
Submitting the examples
- Please create a new branch off of the
bids-examplesrepository - Please name the branch following the convention: bepxxx (e.g. bep003)
- Please label your PR’s with your bep tag. This will clearly differentiate your work from those of the master branch
- When the examples are ready to be merged, please open a pull request against the master branch and tag Ross Blair (@rwblair)
- name: Mark Mikkelsen
- contributions: 📖🔣👀
- email (optional): mam4041@med.cornell.edu
- github (optional): markmikkelsen
- affiliation (optional): Weill Cornell Medicine
- orcid (optional): 0000-0002-0349-3782
- bio (optional):
- website (optional):