From 999b897055994e84915f7e83dc825144efd6a1eb Mon Sep 17 00:00:00 2001 From: Park-Patrick Date: Thu, 11 Oct 2018 12:21:59 -0400 Subject: [PATCH 1/7] pull of common elements from starter kit + some edits --- CONTRIBUTING.md | 105 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 93 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a53de5c22e..0469fd4aaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,95 @@ # Contributors guide -## Markdown style - -The specification documents follow the -[Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). 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). -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. +# Contributing to the BIDS Specification + +:tada::balloon::cake: **Welcome to the BIDS Specification repository!** :cake::balloon::tada: + +:dizzy::hatched_chick::sunny: *We're so excited you're here and want to contribute.* :sunny::hatched_chick::dizzy: + +We hope that these guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know through one of the many ways to [get in touch](#get-in-touch). + +## Table of contents + +Been here before? Already know what you're looking for in this guide? Jump to the following sections: + +* [Joining the BIDS community](#joining-the-community) +* [Get in touch](#get-in-touch) +* [Contributing through GitHub](#contributing-through-github) +* [Make a change with a pull request](#making-a-change-with-a-pull-request) + * [Example pull request](#example-pull-request) +* [Recognizing contributions](#recognizing-contributions) + +## Joining the community + +BIDS - the [Brain Imaging Data Structure][bids] - is a growing community of neuroimaging enthusiasts, and we want to make our resources accessible to and engaging for as many researchers as possible. + +We therefore require that all contributions **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md)**. + +How do you know that you're a member of the BIDS community? You're here! You know that BIDS exists! You're officially a member of the community. It's THAT easy! Welcome! :joy::raised_hands: + +## Get in touch + +## Contributing through GitHub + +[git][git] is a really useful tool for version control. [GitHub][github] sits on top of git and supports collaborative and distributed working. + +We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but the BIDS Specification maintainers are here to help you figure out any of the jargon or confusing instructions you encounter! :heart: + +In order to contribute via GitHub you'll need to set up a free account and sign in. Here are some [instructions](https://help.github.com/articles/signing-up-for-a-new-github-account/) to help you get going. Remember that you can ask us any questions you need to along the way. + +## Writing in markdown + +GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). + +Most of the writing that you'll do will be in [Markdown][markdown]. You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with a little bit of formatting. For example you could write words as bold (`**bold**`), or in italics (`*italics*`), or as a [link][rick-roll] (`[link](https://https://youtu.be/dQw4w9WgXcQ)`) to another webpage. + +## Making a change with a pull request + +We appreciate all contributions to the BIDS Starter Kit. **THANK YOU** for helping us build this useful resource. :sparkles::star2::dizzy: + +:point_right: Remember that if you're adding information to the [wiki](#wiki) you ***don't need to submit a pull request***. You can just log into GitHub, navigate to the [wiki][bids-starterkit-wiki] and click the **edit** button. + +If you're updating the [code](#code) or the [templates](#templates), the following steps are a guide to help you contribute in a way that will be easy for everyone to review and accept with ease :sunglasses:. + +#### 1. Comment on an existing issue or open a new issue referencing your addition + +This allows other members of the BIDS Starter Kit team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out. + +[This blog][dont-push-pull-request] is a nice explanation of why putting this work in up front is so useful to everyone involved. + +#### 2. [Fork][github-fork] the [BIDS Starter Kit repository][bids-starterkit-repo] to your profile + +This is now your own unique copy of the BIDS Starter Kit. Changes here won't affect anyone else's work, so it's a safe space to explore edits to the code! + +Make sure to [keep your fork up to date][github-syncfork] with the master repository, otherwise you can end up with lots of dreaded [merge conflicts][github-mergeconflicts]. + +#### 3. Make the changes you've discussed + +Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. [Help them help you][jerry-maguire] :wink: + +If you feel tempted to "branch out" then please make a [new branch][github-branches] and a [new issue][bids-starterkit-issues] to go with it. + +#### 4. Submit a [pull request][github-pullrequest] + +A member of the BIDS Starter Kit team will review your changes to confirm that they can be merged into the main codebase. + +A [review][github-review] 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][github-fork] of the BIDS Starter Kit [repository][bids-starterkit-repo] and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review. + +GitHub has a [nice introduction][github-flow] to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions :balloon:. + +## Example pull request +Example-Contribution + +
+ +
+ +## Recognizing contributions + +BIDS follows the [all-contributors][all-contributors] specification, so we welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors in the [BIDS specification][bids-specification]. + +## Thank you! + +You're awesome. :wave::smiley: From 6c8c0737e0c10e414a42819e1966c0e5af184a3d Mon Sep 17 00:00:00 2001 From: Park-Patrick Date: Fri, 12 Oct 2018 04:00:31 -0400 Subject: [PATCH 2/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0469fd4aaa..bc7e80cbb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,9 @@ # Contributing to the BIDS Specification -:tada::balloon::cake: **Welcome to the BIDS Specification repository!** :cake::balloon::tada: +**Welcome to the BIDS Specification repository!** -:dizzy::hatched_chick::sunny: *We're so excited you're here and want to contribute.* :sunny::hatched_chick::dizzy: +*We're so excited you're here and want to contribute.* We hope that these guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know through one of the many ways to [get in touch](#get-in-touch). @@ -15,6 +15,7 @@ Been here before? Already know what you're looking for in this guide? Jump to th * [Joining the BIDS community](#joining-the-community) * [Get in touch](#get-in-touch) * [Contributing through GitHub](#contributing-through-github) +* [Writing in markdown](#writing-in-markdown) * [Make a change with a pull request](#making-a-change-with-a-pull-request) * [Example pull request](#example-pull-request) * [Recognizing contributions](#recognizing-contributions) @@ -39,23 +40,27 @@ In order to contribute via GitHub you'll need to set up a free account and sign ## Writing in markdown -GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). +The specification documents follow the +[Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). 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). +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. -Most of the writing that you'll do will be in [Markdown][markdown]. You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with a little bit of formatting. For example you could write words as bold (`**bold**`), or in italics (`*italics*`), or as a [link][rick-roll] (`[link](https://https://youtu.be/dQw4w9WgXcQ)`) to another webpage. +GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). ## Making a change with a pull request -We appreciate all contributions to the BIDS Starter Kit. **THANK YOU** for helping us build this useful resource. :sparkles::star2::dizzy: - -:point_right: Remember that if you're adding information to the [wiki](#wiki) you ***don't need to submit a pull request***. You can just log into GitHub, navigate to the [wiki][bids-starterkit-wiki] and click the **edit** button. - -If you're updating the [code](#code) or the [templates](#templates), the following steps are a guide to help you contribute in a way that will be easy for everyone to review and accept with ease :sunglasses:. +We appreciate all contributions to the BIDS Specification. **THANK YOU** for helping us build this useful resource. #### 1. Comment on an existing issue or open a new issue referencing your addition -This allows other members of the BIDS Starter Kit team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out. +This allows other members of the BIDS Specification team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out. -[This blog][dont-push-pull-request] is a nice explanation of why putting this work in up front is so useful to everyone involved. #### 2. [Fork][github-fork] the [BIDS Starter Kit repository][bids-starterkit-repo] to your profile @@ -65,17 +70,15 @@ Make sure to [keep your fork up to date][github-syncfork] with the master reposi #### 3. Make the changes you've discussed -Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. [Help them help you][jerry-maguire] :wink: - -If you feel tempted to "branch out" then please make a [new branch][github-branches] and a [new issue][bids-starterkit-issues] to go with it. +Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. #### 4. Submit a [pull request][github-pullrequest] -A member of the BIDS Starter Kit team will review your changes to confirm that they can be merged into the main codebase. +A member of the BIDS Specification team will review your changes to confirm that they can be merged into the main codebase. A [review][github-review] 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][github-fork] of the BIDS Starter Kit [repository][bids-starterkit-repo] and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review. +You can update your [fork][github-fork] of the BIDS Specification and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review. GitHub has a [nice introduction][github-flow] to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions :balloon:. From 3bdca0c74ea94585ec74815eb2b013ffcc626ad8 Mon Sep 17 00:00:00 2001 From: Park-Patrick Date: Fri, 12 Oct 2018 04:03:24 -0400 Subject: [PATCH 3/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc7e80cbb1..04fe368621 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,3 @@ -# Contributors guide # Contributing to the BIDS Specification @@ -26,7 +25,7 @@ BIDS - the [Brain Imaging Data Structure][bids] - is a growing community of neur We therefore require that all contributions **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md)**. -How do you know that you're a member of the BIDS community? You're here! You know that BIDS exists! You're officially a member of the community. It's THAT easy! Welcome! :joy::raised_hands: +How do you know that you're a member of the BIDS community? You're here! You know that BIDS exists! You're officially a member of the community. It's THAT easy! Welcome! ## Get in touch @@ -34,7 +33,7 @@ How do you know that you're a member of the BIDS community? You're here! You kno [git][git] is a really useful tool for version control. [GitHub][github] sits on top of git and supports collaborative and distributed working. -We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but the BIDS Specification maintainers are here to help you figure out any of the jargon or confusing instructions you encounter! :heart: +We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but the BIDS Specification maintainers are here to help you figure out any of the jargon or confusing instructions you encounter! In order to contribute via GitHub you'll need to set up a free account and sign in. Here are some [instructions](https://help.github.com/articles/signing-up-for-a-new-github-account/) to help you get going. Remember that you can ask us any questions you need to along the way. @@ -80,7 +79,7 @@ A [review][github-review] will probably consist of a few questions to help clari You can update your [fork][github-fork] of the BIDS Specification and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review. -GitHub has a [nice introduction][github-flow] to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions :balloon:. +GitHub has a [nice introduction][github-flow] to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions. ## Example pull request Example-Contribution From 0a5654f78e37b5b73c1b1ef5f6b3e226758dac5a Mon Sep 17 00:00:00 2001 From: Franklin Feingold <35307458+franklin-feingold@users.noreply.github.com> Date: Fri, 12 Oct 2018 11:40:29 -0700 Subject: [PATCH 4/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 109 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 95 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a53de5c22e..ce92e5a78e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,95 @@ -# Contributors guide - -## Markdown style - -The specification documents follow the -[Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). 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). -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. + +# Contributing to the BIDS Specification + +**Welcome to the BIDS Specification repository!** + +*We're so excited you're here and want to contribute.* + +We hope that these guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know through one of the many ways to [get in touch](#get-in-touch). + +## Table of contents + +Been here before? Already know what you're looking for in this guide? Jump to the following sections: + +* [Joining the BIDS community](#joining-the-community) +* [Get in touch](#get-in-touch) +* [Contributing through GitHub](#contributing-through-github) +* [Writing in markdown](#writing-in-markdown) +* [Make a change with a pull request](#making-a-change-with-a-pull-request) +* [Example pull request](#example-pull-request) +* [Recognizing contributions](#recognizing-contributions) + +## Joining the community + +BIDS - the [Brain Imaging Data Structure](http://bids.neuroimaging.io/) - is a growing community of neuroimaging enthusiasts, and we want to make our resources accessible to and engaging for as many researchers as possible. + +We therefore require that all contributions **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md)**. + +How do you know that you're a member of the BIDS community? You're here! You know that BIDS exists! You're officially a member of the community. It's THAT easy! Welcome! + +## Get in touch + +## Contributing through GitHub + +[Git](https://git-scm.com/) is a really useful tool for version control. [GitHub](https://github.com/) sits on top of git and supports collaborative and distributed working. + +We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but the BIDS Specification maintainers are here to help you figure out any of the jargon or confusing instructions you encounter! + +In order to contribute via GitHub you'll need to set up a free account and sign in. Here are some [instructions](https://help.github.com/articles/signing-up-for-a-new-github-account/) to help you get going. Remember that you can ask us any questions you need to along the way. + +## Writing in markdown + +The specification documents follow the [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). + +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. + +We have deployed a continous integrator ([circle CI](https://circleci.com/)) to further allow for integrating changes continously. The CI is testing that the changes are inline with our standard styling. + +GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). + +## Making a change with a pull request + +We appreciate all contributions to the BIDS Specification. **THANK YOU** for helping us build this useful resource. + +#### 1. Comment on an existing issue or open a new issue referencing your addition + +This allows other members of the BIDS Specification team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out. + + +#### 2. [Fork](https://help.github.com/articles/fork-a-repo/) [this repository](https://github.com/bids-standard/bids-specification) to your profile + +This is now your own unique copy of the BIDS Specification. Changes here won't affect anyone else's work, so it's a safe space to explore edits to the specification! + +Make sure to [keep your fork up to date](https://help.github.com/articles/syncing-a-fork/) with the master repository, otherwise you can end up with lots of dreaded [merge conflicts](https://help.github.com/articles/about-merge-conflicts/). + +#### 3. Make the changes you've discussed + +Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. Please detail the changes you are attempting to make. + +#### 4. Submit a [pull request](https://help.github.com/articles/about-pull-requests/) + +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. + +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. + +GitHub has a [nice introduction](https://help.github.com/articles/github-flow/) to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions. + +## Example pull request +Example-Contribution + +
+ +
+ +## Recognizing contributions + +BIDS follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification, so we welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors in the [BIDS specification](https://github.com/bids-standard/bids-specification/blob/master/src/99-appendices/01-contributors.md). + +## Thank you! + +You're awesome. From 63c245a54787dbb3faadf7e56578ab567c9bbf01 Mon Sep 17 00:00:00 2001 From: Franklin Feingold <35307458+franklin-feingold@users.noreply.github.com> Date: Wed, 24 Oct 2018 23:29:37 +0000 Subject: [PATCH 5/7] Add files via upload --- CONTRIBUTING.md | 93 +++++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 41 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 409e2d787e..2b5e72d9fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,19 +11,17 @@ We hope that these guidelines are designed to make it as easy as possible to get Been here before? Already know what you're looking for in this guide? Jump to the following sections: - -======= -* [Joining the BIDS community](#joining-the-community) -* [Get in touch](#get-in-touch) -* [Contributing through GitHub](#contributing-through-github) -* [Writing in markdown](#writing-in-markdown) -* [Make a change with a pull request](#making-a-change-with-a-pull-request) - * [Example pull request](#example-pull-request) -* [Recognizing contributions](#recognizing-contributions) +* [Joining the BIDS community](#joining-the-community) +* [Get in touch](#get-in-touch) +* [Contributing through GitHub](#contributing-through-github) +* [Writing in markdown](#writing-in-markdown) +* [Make a change with a pull request](#making-a-change-with-a-pull-request) +* [Example pull request](#example-pull-request) +* [Recognizing contributions](#recognizing-contributions) ## Joining the community -BIDS - the [Brain Imaging Data Structure][bids] - is a growing community of neuroimaging enthusiasts, and we want to make our resources accessible to and engaging for as many researchers as possible. +BIDS - the [Brain Imaging Data Structure](http://bids.neuroimaging.io/) - is a growing community of neuroimaging enthusiasts, and we want to make our resources accessible to and engaging for as many researchers as possible. We therefore require that all contributions **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md)**. @@ -33,9 +31,7 @@ How do you know that you're a member of the BIDS community? You're here! You kno ## Contributing through GitHub - -======= -[git][git] is a really useful tool for version control. [GitHub][github] sits on top of git and supports collaborative and distributed working. +[Git](https://git-scm.com/) is a really useful tool for version control. [GitHub](https://github.com/) sits on top of git and supports collaborative and distributed working. We know that it can be daunting to start using git and GitHub if you haven't worked with them in the past, but the BIDS Specification maintainers are here to help you figure out any of the jargon or confusing instructions you encounter! @@ -43,52 +39,69 @@ In order to contribute via GitHub you'll need to set up a free account and sign ## Writing in markdown -======= -The specification documents follow the -[Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). 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). -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. +The specification documents follow the [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/). + +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. + +We have deployed a continous integrator ([circle CI](https://circleci.com/)) to further allow for integrating changes continously. The CI is testing that the changes are inline with our standard styling. GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). -## Making a change with a pull request +## Building the specification using mkdocs + +We are using mkdocs to render our specification. Please follow these instructions if you would like to build the specification locally. + +#### 1. Install mkdocs + +To begin please follow [this link](https://www.mkdocs.org/#installation) to install mkdocs locally. + +#### 2. Download the BIDS specification [repository](https://github.com/bids-standard/bids-specification/tree/master) onto your computer + +This can be done by clicking the green button the right titled "Clone or download" +#### 3. Install our theme -======= -We appreciate all contributions to the BIDS Specification. **THANK YOU** for helping us build this useful resource. +Please go [here](https://squidfunk.github.io/mkdocs-material/) and install our theme - material. The command is `pip install mkdocs-material` + +#### 4. In the terminal (command line) navigate to your local version of the specification + +This location will have the same files you see on our [main specification page](https://github.com/bids-standard/bids-specification) + +#### 5. Ready to build! + +Using the terminal (command line) please enter `mkdocs serve`. This will allow you to see a local version of the specification. The local address will be `http://127.0.0.1:8000`. You may enter that into your browser and this will bring up the specification! + +## Making a change with a pull request + +We appreciate all contributions to the BIDS Specification. **THANK YOU** for helping us build this useful resource. #### 1. Comment on an existing issue or open a new issue referencing your addition This allows other members of the BIDS Specification team to confirm that you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out. +#### 2. [Fork](https://help.github.com/articles/fork-a-repo/) [this repository](https://github.com/bids-standard/bids-specification) to your profile -======= -#### 2. [Fork][github-fork] the [BIDS Starter Kit repository][bids-starterkit-repo] to your profile +This is now your own unique copy of the BIDS Specification. Changes here won't affect anyone else's work, so it's a safe space to explore edits to the specification! -This is now your own unique copy of the BIDS Starter Kit. Changes here won't affect anyone else's work, so it's a safe space to explore edits to the code! - -Make sure to [keep your fork up to date][github-syncfork] with the master repository, otherwise you can end up with lots of dreaded [merge conflicts][github-mergeconflicts]. +Make sure to [keep your fork up to date](https://help.github.com/articles/syncing-a-fork/) with the master repository, otherwise you can end up with lots of dreaded [merge conflicts](https://help.github.com/articles/about-merge-conflicts/). #### 3. Make the changes you've discussed -Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. +Try to keep the changes focused. If you submit a large amount of work in all in one go it will be much more work for whomever is reviewing your pull request. Please detail the changes you are attempting to make. -#### 4. Submit a [pull request][github-pullrequest] +#### 4. Submit a [pull request](https://help.github.com/articles/about-pull-requests/) A member of the BIDS Specification team will review your changes to confirm that they can be merged into the main codebase. -A [review][github-review] 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][github-fork] of the BIDS Specification and the pull request will automatically update with those changes. You don't need to submit a new pull request when you make a change in response to a review. +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. -GitHub has a [nice introduction][github-flow] to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions. +GitHub has a [nice introduction](https://help.github.com/articles/github-flow/) to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions. ## Example pull request Example-Contribution @@ -99,10 +112,8 @@ GitHub has a [nice introduction][github-flow] to the pull request workflow, but ## Recognizing contributions - -======= -BIDS follows the [all-contributors][all-contributors] specification, so we welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors in the [BIDS specification][bids-specification]. +BIDS follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification, so we welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors in the [BIDS specification](https://github.com/bids-standard/bids-specification/blob/master/src/99-appendices/01-contributors.md). ## Thank you! -You're awesome. :wave::smiley: +You're awesome. From 184b86880689f9477ae3a1c134fcdc564d1a8cca Mon Sep 17 00:00:00 2001 From: Franklin Feingold <35307458+franklin-feingold@users.noreply.github.com> Date: Wed, 24 Oct 2018 16:52:32 -0700 Subject: [PATCH 6/7] Small edit --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b5e72d9fc..037846fedc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ To begin please follow [this link](https://www.mkdocs.org/#installation) to inst #### 2. Download the BIDS specification [repository](https://github.com/bids-standard/bids-specification/tree/master) onto your computer -This can be done by clicking the green button the right titled "Clone or download" +This can be done by clicking the green button on the right titled "Clone or download" #### 3. Install our theme @@ -68,7 +68,7 @@ Please go [here](https://squidfunk.github.io/mkdocs-material/) and install our t #### 4. In the terminal (command line) navigate to your local version of the specification -This location will have the same files you see on our [main specification page](https://github.com/bids-standard/bids-specification) +This location will have the same files you see on our [main specification page](https://github.com/bids-standard/bids-specification). Note: A finder window may not show the hidden files (those that start with a period i.e. .remarkrc) #### 5. Ready to build! From 98cd12720d6f0e18d48f0e1b8c354eb6963479b4 Mon Sep 17 00:00:00 2001 From: Franklin Feingold <35307458+franklin-feingold@users.noreply.github.com> Date: Wed, 24 Oct 2018 16:53:51 -0700 Subject: [PATCH 7/7] Small edit --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 037846fedc..314170e2fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ This can be done by clicking the green button on the right titled "Clone or down #### 3. Install our theme -Please go [here](https://squidfunk.github.io/mkdocs-material/) and install our theme - material. The command is `pip install mkdocs-material` +Please go [here](https://squidfunk.github.io/mkdocs-material/) and install our theme - material. The terminal command is `pip install mkdocs-material` #### 4. In the terminal (command line) navigate to your local version of the specification