Skip to content

Commit

Permalink
[DOC] Include [all] in developer setup install guidelines (#572)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo authored Jul 17, 2020
1 parent ddaa4d5 commit 5ccc4f2
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
26 changes: 14 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
2 changes: 1 addition & 1 deletion docs/developing.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
====================
Developer Guidelines
Developer guidelines
====================

This webpage is intended to guide users through making making changes to
Expand Down

0 comments on commit 5ccc4f2

Please sign in to comment.