Skip to content

Commit ab90a17

Browse files
authored
Merge pull request #248 from openneuropet/update-docs
Instruct User to Use Bash Over zsh for Development
2 parents 8b744a8 + 9a313d8 commit ab90a17

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Project organization
2020
How to contribute code
2121
----------------------
2222

23-
The preferred way to contribute to the BIDScoin code base or documentation is to use a `forking wokflow <https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow>`__, i.e. fork the `main repository <https://github.com/Donders-Institute/bidscoin>`__, 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:
23+
The preferred way to contribute to the BIDScoin code base or documentation is to use a `forking workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow>`__, i.e. fork the `main repository <https://github.com/Donders-Institute/bidscoin>`__, 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:
2424

2525
0. Fork the `project repository <https://github.com/Donders-Institute/bidscoin>`_ on GitHub, by clicking on the “Fork” button near the top of the page — this will create a personal copy of the repository.
2626

@@ -51,6 +51,8 @@ The preferred way to contribute to the BIDScoin code base or documentation is to
5151

5252
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 <http://git-scm.com/documentation>`__ or `GitHub <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`__ documentation on the web)
5353

54+
.. 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.
55+
5456
Coding guidelines
5557
-----------------
5658

0 commit comments

Comments
 (0)