diff --git a/CODEOWNERS b/CODEOWNERS index 0ef42927de..a2a1aa2467 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -5,7 +5,7 @@ # Request for Review) please add your GitHub username next to the file you want to # monitor below. -# Add your github name below to get notified about proposed releases +# Add your GitHub name below to get notified about proposed releases /src/CHANGES.md @chrisfilo @sappelhoff @CPernet # Individual sections diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3ccb3db16..b1f67a1d85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ The specification documents follow the [Markdown Style Guide](http://www.cirosan You can validate your changes against the guide using [remark](https://github.com/remarkjs/remark-lint) which works as a [standalone command line tool](https://github.com/remarkjs/remark/tree/master/packages/remark-cli) as well as [a plugin for various text editors](https://github.com/remarkjs/remark-lint#editor-integrations). Remark preserves consistent markdown styling across the contributions. Please ensure before submitting a contribution that you do not have any linter errors in your text editor. -You can also use [prettier](https://github.com/prettier/prettier) to automatically correct some of the style issuse that might be found in the proposed changes. +You can also use [prettier](https://github.com/prettier/prettier) to automatically correct some of the style issues that might be found in the proposed changes. We have deployed a continuous integrator ([circle CI](https://circleci.com/)) to further allow for integrating changes continuously. The CI is testing that the changes are inline with our standard styling. @@ -97,7 +97,7 @@ Try to keep the changes focused. If you submit a large amount of work in all in A member of the BIDS Specification team will review your changes to confirm that they can be merged into the main codebase. -A [review](https://help.github.com/articles/about-pull-request-reviews/) will probably consist of a few questions to help clarify the work you've done. Keep an eye on your github notifications and be prepared to join in that conversation. +A [review](https://help.github.com/articles/about-pull-request-reviews/) will probably consist of a few questions to help clarify the work you've done. Keep an eye on your GitHub notifications and be prepared to join in that conversation. You can update your [fork](https://help.github.com/articles/about-forks/) of the BIDS Specification and the pull request will automatically update with those commits. You don't need to submit a new pull request when you make a change in response to a review. diff --git a/DECISION-MAKING.md b/DECISION-MAKING.md index a83dc08e1d..32c9d064a7 100644 --- a/DECISION-MAKING.md +++ b/DECISION-MAKING.md @@ -91,9 +91,9 @@ when necessary. Current Maintainers: example it is perfectly fine for a PR to consist of content developed by a group of experts over an extended period of time via in person meetings and online collaborations using a Google Document. -1. To facilitate triaging of incoming PR you can subscribe to +1. To facilitate triage of incoming PR you can subscribe to notifications for new PRs proposing changes to specific files. To do this - add your Github name next to the file you want to subscribe to in the + add your GitHub name next to the file you want to subscribe to in the [CODEOWNERS](CODEOWNERS). This way you will be ask to review each relevant PR. Please mind that lack of your review will not prevent the PR from being merged so if you think the PR needs your attention, please review it diff --git a/Release_Protocol.md b/Release_Protocol.md index 519be65c63..3ff0608a0e 100644 --- a/Release_Protocol.md +++ b/Release_Protocol.md @@ -19,7 +19,7 @@ Important note: The pull request title **needs** to follow this protocol. REL: v ### This will open a period of discussion for 5 business days regarding if we are ready to release. This will also freeze all pull request merging. -If we determine we are ready to release, please have the PR submitter add an additional commit with the date in year-month-date format in parentheses after the version of the date of merging (not opening) (i.e. it should read v1.1.2 (2018-12-28)) and merge this PR. This will mark a new release. On the same day, please also do a github release. To do this please see below. +If we determine we are ready to release, please have the PR submitter add an additional commit with the date in year-month-date format in parentheses after the version of the date of merging (not opening) (i.e. it should read v1.1.2 (2018-12-28)) and merge this PR. This will mark a new release. On the same day, please also do a GitHub release. To do this please see below. ![GH-release-1](release_images/GH-release_1.png "GH-release-1") diff --git a/src/01-introduction.md b/src/01-introduction.md index e077e6cbb9..fe0f66b676 100644 --- a/src/01-introduction.md +++ b/src/01-introduction.md @@ -45,7 +45,7 @@ different backgrounds. ## Extensions The BIDS specification can be extended in a backwards compatible way and will -evolve over time. This is accomplished through community-driven BIDS Extention +evolve over time. This is accomplished through community-driven BIDS Extension Proposals (BEPs). For more information about the BEP process, and list of current BEP proposals, see [Extending the BIDS specification](06-extensions.md). diff --git a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md index 905586e8b8..341602fd4b 100644 --- a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md +++ b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md @@ -20,7 +20,7 @@ by Ben Inglis: | HardcopyDeviceSoftwareVersion | (Deprecated) Manufacturer’s designation of the software of the device that created this Hardcopy Image (the printer). Corresponds to DICOM Tag 0018, 101A `Hardcopy Device Software Version` | | MagneticFieldStrength | RECOMMENDED. Nominal field strength of MR magnet in Tesla. Corresponds to DICOM Tag 0018,0087 `Magnetic Field Strength` | | ReceiveCoilName | RECOMMENDED. Information describing the receiver coil. Corresponds to DICOM Tag 0018, 1250 `Receive Coil Name`, although not all vendors populate that DICOM Tag, in which case this field can be derived from an appropriate private DICOM field | -| ReceiveCoilActiveElements | RECOMMENDED. Information describing the active/selected elements of the receiver coil. This doesn’t correspond to a tag in the DICOM ontology. The vendor-defined terminology for active coil elements can go in this field. As an example, for Siemens, coil channels are typically not activated/selected individually, but rather in pre-defined selectable "groups" of individual channels, and the list of the "groups" of elements that are active/selected in any given scan populates the `Coil String` entry in Siemen’s private DICOM fields (e.g., `HEA;HEP` for the Siemens standard 32 ch coil when both the anterior and posterior groups are activated). This is a flexible field that can be used as most appropriate for a given vendor and coil to define the "active" coil elements. Since individual scans can sometimes not have the intended coil elements selected, it is preferable for this field to be populated directly from the DICOM for each individual scan, so that it can be used as a mechanism for checking that a given scan was collected with the intended coil elements selected | +| ReceiveCoilActiveElements | RECOMMENDED. Information describing the active/selected elements of the receiver coil. This doesn’t correspond to a tag in the DICOM ontology. The vendor-defined terminology for active coil elements can go in this field. As an example, for Siemens, coil channels are typically not activated/selected individually, but rather in pre-defined selectable "groups" of individual channels, and the list of the "groups" of elements that are active/selected in any given scan populates the `Coil String` entry in Siemens’ private DICOM fields (e.g., `HEA;HEP` for the Siemens standard 32 ch coil when both the anterior and posterior groups are activated). This is a flexible field that can be used as most appropriate for a given vendor and coil to define the "active" coil elements. Since individual scans can sometimes not have the intended coil elements selected, it is preferable for this field to be populated directly from the DICOM for each individual scan, so that it can be used as a mechanism for checking that a given scan was collected with the intended coil elements selected | | GradientSetType | RECOMMENDED. It should be possible to infer the gradient coil from the scanner model. If not, e.g. because of a custom upgrade or use of a gradient insert set, then the specifications of the actual gradient coil should be reported independently | | MRTransmitCoilSequence | RECOMMENDED. This is a relevant field if a non-standard transmit coil is used. Corresponds to DICOM Tag 0018, 9049 `MR Transmit Coil Sequence` | | MatrixCoilMode | RECOMMENDED. (If used) A method for reducing the number of independent channels by combining in analog the signals from multiple coil elements. There are typically different default modes when using un-accelerated or accelerated (e.g. GRAPPA, SENSE) imaging |