diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c33c4615..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. @@ -51,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 -----------------