From 03ed014fce7c42f05eae346ac0ac8a4999d07c8c Mon Sep 17 00:00:00 2001 From: Anthony Galassi <28850131+bendhouseart@users.noreply.github.com> Date: Thu, 7 Nov 2024 13:24:10 -0500 Subject: [PATCH 1/3] added note to switch to bash --- CONTRIBUTING.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c33c4615..118200e3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -39,6 +39,10 @@ The preferred way to contribute to the BIDScoin code base or documentation is to pip uninstall bidscoin # Hence we need to retrospectively remove BIDScoin from site-packages # NB: Install dcm2niix yourself (see the online installation instructions) + .. note:: + Some users have reported issues with pip installing .[dev] or similar syntax on Mac, + if you encounter this issues try switching shells from zsh to bash. + 3. When you wish to start a new contribution, create a new branch:: git checkout -b [topic_of_your_contribution] From ff729f70fc0a1369e600549bc252c1fefdb4797e Mon Sep 17 00:00:00 2001 From: Anthony Galassi <28850131+bendhouseart@users.noreply.github.com> Date: Thu, 7 Nov 2024 13:25:19 -0500 Subject: [PATCH 2/3] reformat --- CONTRIBUTING.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 118200e3..fb8cc89c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -39,9 +39,9 @@ The preferred way to contribute to the BIDScoin code base or documentation is to pip uninstall bidscoin # Hence we need to retrospectively remove BIDScoin from site-packages # NB: Install dcm2niix yourself (see the online installation instructions) - .. note:: - Some users have reported issues with pip installing .[dev] or similar syntax on Mac, - if you encounter this issues try switching shells from zsh to bash. +.. note:: + Some users have reported issues with pip installing .[dev] or similar syntax on Mac, + if you encounter this issues try switching shells from zsh to bash. 3. When you wish to start a new contribution, create a new branch:: From 9a313d81103832bbc938376167e8dfd46ba34fa4 Mon Sep 17 00:00:00 2001 From: Anthony Galassi <28850131+bendhouseart@users.noreply.github.com> Date: Thu, 7 Nov 2024 13:40:51 -0500 Subject: [PATCH 3/3] put note at bottom of section --- CONTRIBUTING.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fb8cc89c..feff9e8c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -20,7 +20,7 @@ Project organization How to contribute code ---------------------- -The preferred way to contribute to the BIDScoin code base or documentation is to use a `forking wokflow `__, i.e. fork the `main repository `__, create a feature branch, and submit a pull request. If you are unsure what that means, here is a set-up workflow you may wish to follow: +The preferred way to contribute to the BIDScoin code base or documentation is to use a `forking workflow `__, i.e. fork the `main repository `__, create a feature branch, and submit a pull request. If you are unsure what that means, here is a set-up workflow you may wish to follow: 0. Fork the `project repository `_ on GitHub, by clicking on the “Fork” button near the top of the page — this will create a personal copy of the repository. @@ -39,10 +39,6 @@ The preferred way to contribute to the BIDScoin code base or documentation is to pip uninstall bidscoin # Hence we need to retrospectively remove BIDScoin from site-packages # NB: Install dcm2niix yourself (see the online installation instructions) -.. note:: - Some users have reported issues with pip installing .[dev] or similar syntax on Mac, - if you encounter this issues try switching shells from zsh to bash. - 3. When you wish to start a new contribution, create a new branch:: git checkout -b [topic_of_your_contribution] @@ -55,6 +51,8 @@ The preferred way to contribute to the BIDScoin code base or documentation is to Git will provide you with a link which you can click to initiate a pull request (if any of the above seems overwhelming, you can look up the `Git `__ or `GitHub `__ documentation on the web) +.. Some Mac users on have encountered issues when running pip install bidscoin[dev] or pip install .[all] during setup. If you encounter this try switching from zsh to bash. + Coding guidelines -----------------