A few updates to the roadmap and contributing guidelines #18

KirstieJane · 2018-11-03T21:52:02Z

In reference to pull request ME-ICA#151

Changes proposed in this pull request:

Add opinionated description of whether tedana is backwards compatible with MEICA
Add links to milestones and standardise how they're referred to ("Associated milestone" vs "Milestone")
Change (again) a tiny phrasing as relates to the code of conduct
Add example of multiple tags for pull requests
Add a couple more guiding comments to the pull request template - feel free to ignore if they're too verbose
Add vscode to gitignore file

What became VERY apparent is that I don't know how to write .rst and I haven't built the docs to check, so I think my edits will need a look over for formatting. SORRY 😭

Also, I made a mess of the different commits in my git history and I haven't cleaned them up because I don't want to make more of a mess! But if you'd like me to do a better job there I can do 😬

Also added an example of combining labels.

Totally fine to reject this change if you think its too verbose :)

Also added an example of combining labels.

Also standardised how they're referred to between the different milesones :)

emdupre

Thanks so much, @KirstieJane ! Your rst formatting is perfect, actually 🎉

I did have a few small requests, but most of them are stylistic. Thanks so much for these edits and your always extremely helpful feedback !!!

emdupre · 2018-11-05T20:43:07Z

.github/pull_request_template.md

@@ -9,8 +9,12 @@ See here for more information and a list of available options:
 http://tedana.readthedocs.io/en/latest/contributing.html#pull-requests


Could you update this URL to point to the new CONTRIBUTING.md section on pull requests ? Otherwise this will return a 404 ! Sorry for missing it myself !!

emdupre · 2018-11-05T20:45:47Z

docs/contributing.rst

@@ -132,6 +132,29 @@ mean that this work should be relatively manageable.
 We hope that the lessons we learn building something useful in the short term will be
 applicable in the future as other needs arise.

+.. _backwards compatibility with meica:


Can you add this section to the TOC ? Also, I think it might make sense to place this before "how does tedana future-proof its development" since that directly feeds into the release checklist !

emdupre · 2018-11-05T20:46:01Z

docs/contributing.rst

+
+The short answer is no.
+
+There are two main reasons why. One is that the tool originally used to run the independent


Can we put each sentence on its own line ?

emdupre · 2018-11-05T20:47:06Z

docs/contributing.rst

+The other reason is a choice of the core developers to look forwards rather than maintaining
+an older codebase. As is described `above`_, ``tedana`` is developed by a small team of
+volunteers and they have to allocate their time accordingly. If you'd like to use MEICA as has
+been previously published the code is available on `github`_ and freely available under a LGPL2


I think we should actually link to the bitbucket here, rather than the github, since the version on github has actually not previously been published on !

So, the bitbucket link says to go to the github repo....and I figured if someone is trying to use MEICA it would be super annoying to have to go to bitbucket just to then be sent to the github link......

But I know what you mean, so happy to change if you'd like?

This is the only part of your review I haven't done @emdupre - let me know what you think. This is one of my only moderately held opinions....

I see your point here, for sure -- really this is a problem in the bitbucket. We can add it to our to-do list once ME-ICA#119 is merged and the two do really differ

Coolio! Updated - I'll push that change now ✨

emdupre · 2018-11-05T20:49:43Z

docs/contributing.rst

+exactly reproducing MEICA analyses is not possible.
+
+The other reason is a choice of the core developers to look forwards rather than maintaining
+an older codebase. As is described `above`_, ``tedana`` is developed by a small team of


We could actually link this directly out with

As described in the ``tedana`` :ref:`governance` description,

I'm actually not sure where above_ is linking to right now ?

Lolz. Yep. I think I did at some point have a link for "above" but it isn't there anymore!

I've changed this to:

As described in the :ref:`governance` section, ``tedana`` is developed by a small...

Is that the right formatting??

It is ! but sorry, we need to add the link in-text. So above at L11 it should be:

.. _governance: Governance ----------------

emdupre · 2018-11-05T20:51:54Z

docs/roadmap.rst

@@ -51,11 +51,13 @@ One metric of success, then, is to develop documentation that includes:

 .. _a ReadTheDocs site: https://tedana.readthedocs.io

-**Associated Milestone**:
+**Associated Milestone**: `#6`_


Great call ! But the links aren't going to play nicely with the pound signs. Could we actually just wrap it s.t. the links each look like

**`Associated Milestone`_** .. _Associated Milestone: https://github.com/ME-ICA/tedana/milestone/6

?

Yep - see - I knew I didn't know the rst format well enough! I'll make these changes now 😸

emdupre · 2018-11-05T20:53:09Z

.github/pull_request_template.md

@@ -9,8 +9,12 @@ See here for more information and a list of available options:
 http://tedana.readthedocs.io/en/latest/contributing.html#pull-requests
 -->

+<!-- Please indicate after the # which issue you're closing with this PR -->


😍 This is great ! Should we explain that this will automatically close the issue, maybe by including this link ?

emdupre · 2018-11-05T20:56:50Z

CONTRIBUTING.md

@@ -119,6 +119,10 @@ If your pull request is not yet ready to be merged, please also include the **[W
 This tells the development team that your pull request is a "work-in-progress",
 and that you plan to continue working on it.

+You can also combine the tags above, for example if you are updating both a test and


Same question here about new lines !

Also fix a couple of typos & make sure all new sentences start on new lines

Put new sentence on a new line 😃

KirstieJane · 2018-11-05T22:55:50Z

Thanks for the feedback @emdupre! ✨ 💖 💪

emdupre · 2018-11-06T01:23:02Z

Hooray !!! Thanks for the edits. I had one suggestion to fix a link but this is otherwise ready ! If you don't have time to update the PR (since I know you're at a conference 🌯🌞) I can merge and then patch the link myself :)

emdupre · 2018-11-06T01:43:31Z

Thanks !! 🎉✨ Merging now !

KirstieJane added 7 commits November 3, 2018 21:07

Add a sentence about multiple tags for PRs

ce6bf75

Also added an example of combining labels.

Update gitignore to exclude vscode settings

6fb0270

Add a couple more comments to the pull request template

ebab1a8

Totally fine to reject this change if you think its too verbose :)

fix merge conflicts

d82b081

Add a sentence about multiple tags for PRs

5697e68

Also added an example of combining labels.

Add links to milestones

e6b5296

Also standardised how they're referred to between the different milesones :)

Add opinion about not being backwards compatible

32cbb26

KirstieJane changed the base branch from master to doc/roadmap November 3, 2018 21:52

KirstieJane mentioned this pull request Nov 3, 2018

[DOC] Request for Comments: Roadmap and Contributing ME-ICA/tedana#151

Merged

emdupre reviewed Nov 5, 2018

View reviewed changes

KirstieJane added 5 commits November 5, 2018 22:35

Update link to pull request documentation

d0c1bc5

Move sections around and add to TOC

f58c230

Also fix a couple of typos & make sure all new sentences start on new lines

Add link to closing issues docs

4e10b47

Fix links to associated milestones

190c90d

Fix formatting

05b6563

Put new sentence on a new line 😃

Change link to MEICA code from github to bitbucket

4223b64

Add link to governance section

dcecf85

emdupre merged commit a1a8f5e into emdupre:doc/roadmap Nov 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A few updates to the roadmap and contributing guidelines #18

A few updates to the roadmap and contributing guidelines #18

KirstieJane commented Nov 3, 2018 •

edited

Loading

emdupre left a comment

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

KirstieJane Nov 5, 2018

emdupre Nov 6, 2018

KirstieJane Nov 6, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018 •

edited

Loading

emdupre Nov 6, 2018

KirstieJane Nov 6, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

emdupre Nov 5, 2018

emdupre Nov 5, 2018

KirstieJane Nov 5, 2018

KirstieJane commented Nov 5, 2018

emdupre commented Nov 6, 2018

emdupre commented Nov 6, 2018

		@@ -9,8 +9,12 @@ See here for more information and a list of available options:
		http://tedana.readthedocs.io/en/latest/contributing.html#pull-requests


		The short answer is no.

		There are two main reasons why. One is that the tool originally used to run the independent

A few updates to the roadmap and contributing guidelines #18

A few updates to the roadmap and contributing guidelines #18

Conversation

KirstieJane commented Nov 3, 2018 • edited Loading

emdupre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KirstieJane Nov 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KirstieJane commented Nov 5, 2018

emdupre commented Nov 6, 2018

emdupre commented Nov 6, 2018

KirstieJane commented Nov 3, 2018 •

edited

Loading

KirstieJane Nov 5, 2018 •

edited

Loading