From 5ccc4f2917d9f3a06da4399439d1eca8143eb0d1 Mon Sep 17 00:00:00 2001 From: Taylor Salo Date: Fri, 17 Jul 2020 18:16:16 -0400 Subject: [PATCH] [DOC] Include [all] in developer setup install guidelines (#572) --- CONTRIBUTING.md | 26 ++++++++++++++------------ README.md | 3 ++- docs/developing.rst | 2 +- 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3116ab1ac..26c0c5501 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,9 +22,9 @@ Already know what you're looking for in this guide? Jump to the following sectio * [Recognizing contributors](#Recognizing-contributors) * [Monthly calls and testing guidelines][link_developing_rtd] -Don't know where to get started? -Read [Joining the conversation](#joining-the-conversation) and pop into -Gitter to introduce yourself! Let us know what your interests are and we +Don't know where to get started? +Read [Joining the conversation](#joining-the-conversation) and pop into +Gitter to introduce yourself! Let us know what your interests are and we will help you find an issue to contribute to. Thanks so much! ## Joining the conversation @@ -129,14 +129,16 @@ Make sure to always [keep your fork up to date][link_updateupstreamwiki] with th ### 3. Run the developer setup -To test a change, you may need to set up your local repository to run a `tedana` workflow. +To test a change, you may need to set up your local repository to run a `tedana` workflow. To do so, run ``` -pip install -e . +pip install -e .[all] ``` -from within your local `tedana` repository. This should ensure all packages are correctly organized and linked on your user profile. +from within your local `tedana` repository. This should ensure all packages are correctly organized and linked on your user profile. -Once you've run this, your repository should be set for most changes (i.e., you do not have to re-run with every change). +We recommend including the `[all]` flag when you install `tedana` so that "extra" requirements necessary for running tests and building the documentation will also be installed. + +Once you've run this, your repository should be set for most changes (i.e., you do not have to re-run with every change). ### 4. Make the changes you've discussed @@ -225,7 +227,7 @@ To push your changes to your remote, use git push -u origin MYBRANCH ``` -and GitHub will respond by giving you a link to open a pull request to +and GitHub will respond by giving you a link to open a pull request to ME-ICA/tedana. Once you have pushed changes to the repository, please do not use commands such as rebase and amend, as they will rewrite your history and make it difficult for developers to work with you on @@ -295,11 +297,11 @@ And, if you have any questions, please don't hesitate to ask! ## Recognizing contributors -We welcome and recognize [all contributions][link_all-contributors-spec] +We welcome and recognize [all contributions][link_all-contributors-spec] from documentation to testing to code development. -You can see a list of current contributors in the +You can see a list of current contributors in the README -(kept up to date by the [all contributors bot][link_all-contributors-bot]). +(kept up to date by the [all contributors bot][link_all-contributors-bot]). You can see [here][link_all-contributors-bot-usage] for instructions on how to use the bot. @@ -319,7 +321,7 @@ You're awesome. :wave::smiley: [writing_formatting_github]: https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github [markdown]: https://daringfireball.net/projects/markdown [rick_roll]: https://www.youtube.com/watch?v=dQw4w9WgXcQ -[restructuredtext]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html +[restructuredtext]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html [sphinx]: http://www.sphinx-doc.org/en/master/index.html [readthedocs]: https://docs.readthedocs.io/en/latest/index.html diff --git a/README.md b/README.md index 928207a83..52910c9a7 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,8 @@ If you aim to contribute to the `tedana` code base and/or documentation, please ## Getting involved We :yellow_heart: new contributors! -To get started, check out [our contributing guidelines](https://github.com/ME-ICA/tedana/blob/master/CONTRIBUTING.md). +To get started, check out [our contributing guidelines](https://github.com/ME-ICA/tedana/blob/master/CONTRIBUTING.md) +and our [developer's guide](https://tedana.readthedocs.io/en/latest/developing.html). Want to learn more about our plans for developing ``tedana``? Have a question, comment, or suggestion? diff --git a/docs/developing.rst b/docs/developing.rst index 1cb47cc46..44d472a76 100644 --- a/docs/developing.rst +++ b/docs/developing.rst @@ -1,5 +1,5 @@ ==================== -Developer Guidelines +Developer guidelines ==================== This webpage is intended to guide users through making making changes to