Add documentation for reviewers and a checklist for PRs #315

smoia · 2020-10-14T15:51:43Z

Closes none, depends on #313.

Proposed Changes

Update the PR template to have a checklist of steps that should be completed before promoting a draft PR to "Open PR" (Or before creating one) and more comments.
Add a documentation section on reviewing
Add a documentation section on Main Reviewers

codecov · 2020-10-14T15:58:31Z

Codecov Report

Merging #315 (216d8bf) into master (106f8ad) will increase coverage by 0.13%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #315      +/-   ##
==========================================
+ Coverage   94.81%   94.94%   +0.13%     
==========================================
  Files           9        9              
  Lines         848      871      +23     
==========================================
+ Hits          804      827      +23     
  Misses         44       44

Impacted Files	Coverage Δ
phys2bids/utils.py	`97.97% <0.00%> (+0.61%)`	⬆️

smoia · 2020-10-15T12:47:33Z

I know we didn't solve the issues with auto yet, but I'm going to unpause this already.
@physiopy/phys2bids anyone wants to have a look?

eurunuela

I've some tiny suggestions.

.github/PULL_REQUEST_TEMPLATE.md

docs/contributing.rst

Co-authored-by: Eneko Uruñuela <[email protected]>

RayStick · 2020-10-16T23:27:42Z

Good initiative - this will be helpful.

Do you think including something about the timeline of a review would be needed? (Sorry if I've missed this somewhere)

I.e. "I know this PR needs to be merged before we can work on X", or "it would be great to get this done by X day". Then a reviewer that is assigned to a few PRs might know how best to spend their time, or they say they don't think they can get it done in that time frame (yes, I might be thinking personally here!). I guess that's kind of what the milestones are for, right?

RayStick

I suggested some changes to your branch @smoia. Other than that, LGTM

.github/PULL_REQUEST_TEMPLATE.md

docs/contributorfile.rst

Co-authored-by: Taylor Salo <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Taylor Salo <[email protected]>

smoia · 2020-10-21T21:43:51Z

Ok, addressed most of the suggestions and questions!
However it might be worth addressing those questions during an upcoming meeting. What do you think?

RayStick · 2020-10-23T19:39:41Z

It seems we are waiting to merge this, after discussion in the next meeting on some of the topics raised, is that correct?

smoia · 2020-11-10T22:23:52Z

@tsalo @RayStick @eurunuela I updated a couple of sentences to reflect the discussion we had here and during the last meeting.

Please have a look!

eurunuela

My comments are not critical but I think some of the rephrasing @tsalo suggested should be included.

.github/PULL_REQUEST_TEMPLATE.md

docs/contributorfile.rst

…iews

smoia · 2020-11-11T11:21:24Z

@eurunuela do you think it's clearer now?

eurunuela · 2020-11-11T12:12:57Z

@eurunuela do you think it's clearer now?

Sorry I didn't make it clearer before. I commented on the ones I think should be included.

smoia · 2020-11-11T14:34:00Z

@eurunuela now?

eurunuela

LGTM! Thank you!

smoia · 2020-11-11T15:03:09Z

@tsalo @RayStick if it's ok for you we can merge this in?

tsalo

I'm happy with the changes. Thank you.

smoia · 2020-11-11T17:05:15Z

@RayStick do you mind if we merge this?

eurunuela · 2020-11-11T17:17:10Z

@RayStick do you mind if we merge this?

She already approved, so I guess she's happy 🤷🏻‍♂️

eurunuela · 2020-11-11T17:20:57Z

We should celebrate this!

RayStick · 2020-11-11T21:39:48Z

Great. 🎉

smoia · 2020-11-29T19:15:19Z

🚀 PR was released in 2.3.0 🚀

smoia added 5 commits October 9, 2020 21:43

Update documentation with auto and main reviewer

8a28ec6

Add link to a reviewing best practice

71858b9

Add checklist and change type to PR templates

e533993

Reword

41d946c

Reword and fix typos

9e8f3a8

smoia added Documentation This issue or PR is about the documentation Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog Paused Issue should not be worked on until the resolution of other issues or Pull Requests labels Oct 14, 2020

smoia mentioned this pull request Oct 14, 2020

Add Main Reviewer checklist #316

Draft

smoia removed the Paused Issue should not be worked on until the resolution of other issues or Pull Requests label Oct 15, 2020

smoia assigned RayStick Oct 15, 2020

smoia requested a review from RayStick October 15, 2020 12:47

eurunuela requested changes Oct 15, 2020

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

docs/contributing.rst Outdated Show resolved Hide resolved

Stefano Moia and others added 4 commits October 15, 2020 17:56

Update .github/PULL_REQUEST_TEMPLATE.md

d684e7e

Co-authored-by: Eneko Uruñuela <[email protected]>

Update .github/PULL_REQUEST_TEMPLATE.md

a635d87

Co-authored-by: Eneko Uruñuela <[email protected]>

Update .github/PULL_REQUEST_TEMPLATE.md

3b33c36

Co-authored-by: Eneko Uruñuela <[email protected]>

Update docs/contributing.rst

618d40b

Co-authored-by: Eneko Uruñuela <[email protected]>

doc_update

9eb7f9d

RayStick requested changes Oct 19, 2020

View reviewed changes

tsalo reviewed Oct 19, 2020

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

tsalo reviewed Oct 19, 2020

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

tsalo reviewed Oct 19, 2020

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

tsalo reviewed Oct 19, 2020

View reviewed changes

docs/contributorfile.rst Outdated Show resolved Hide resolved

Stefano Moia and others added 3 commits October 20, 2020 21:43

Update .github/PULL_REQUEST_TEMPLATE.md

42056e2

Co-authored-by: Taylor Salo <[email protected]>

Update .github/PULL_REQUEST_TEMPLATE.md

b4401d3

Co-authored-by: Taylor Salo <[email protected]>

Update docs/contributorfile.rst

78da486

Co-authored-by: Taylor Salo <[email protected]>

smoia commented Oct 20, 2020

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

Stefano Moia and others added 4 commits October 21, 2020 22:55

Update docs/contributorfile.rst

d20a064

Co-authored-by: Taylor Salo <[email protected]>

Update docs/contributorfile.rst

01d67a4

Co-authored-by: Taylor Salo <[email protected]>

Update docs/contributorfile.rst

d62402a

Co-authored-by: Taylor Salo <[email protected]>

Update docs/contributorfile.rst

528e04b

Co-authored-by: Taylor Salo <[email protected]>

smoia added 2 commits November 10, 2020 23:16

Update rules about suggestion tool and direct PR

00e504c

Update labels in PR rules

467fe62

Merge branch 'master' into doc/reviews

4350fd4

eurunuela requested changes Nov 11, 2020

View reviewed changes

smoia added 2 commits November 11, 2020 12:18

Language corrections and rewording of PR section for better clarity

1919324

Merge branch 'doc/reviews' of github.com:smoia/phys2bids into doc/rev…

ff6409f

…iews

Rewording

216d8bf

eurunuela approved these changes Nov 11, 2020

View reviewed changes

tsalo approved these changes Nov 11, 2020

View reviewed changes

smoia self-assigned this Nov 11, 2020

smoia merged commit b965b03 into physiopy:master Nov 11, 2020

smoia deleted the doc/reviews branch November 11, 2020 17:18

smoia mentioned this pull request Nov 13, 2020

Add badges instead of labels name in the contribution guidelines #348

Open

smoia added the released This issue/pull request has been released. label Nov 29, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for reviewers and a checklist for PRs #315

Add documentation for reviewers and a checklist for PRs #315

smoia commented Oct 14, 2020

codecov bot commented Oct 14, 2020 •

edited

Loading

smoia commented Oct 15, 2020

eurunuela left a comment

RayStick commented Oct 16, 2020

RayStick left a comment

smoia commented Oct 21, 2020

RayStick commented Oct 23, 2020

smoia commented Nov 10, 2020

eurunuela left a comment

smoia commented Nov 11, 2020

eurunuela commented Nov 11, 2020

smoia commented Nov 11, 2020

eurunuela left a comment

smoia commented Nov 11, 2020

tsalo left a comment

smoia commented Nov 11, 2020

eurunuela commented Nov 11, 2020

eurunuela commented Nov 11, 2020

RayStick commented Nov 11, 2020

smoia commented Nov 29, 2020

Add documentation for reviewers and a checklist for PRs #315

Add documentation for reviewers and a checklist for PRs #315

Conversation

smoia commented Oct 14, 2020

Proposed Changes

codecov bot commented Oct 14, 2020 • edited Loading

Codecov Report

smoia commented Oct 15, 2020

eurunuela left a comment

Choose a reason for hiding this comment

RayStick commented Oct 16, 2020

RayStick left a comment

Choose a reason for hiding this comment

smoia commented Oct 21, 2020

RayStick commented Oct 23, 2020

smoia commented Nov 10, 2020

eurunuela left a comment

Choose a reason for hiding this comment

smoia commented Nov 11, 2020

eurunuela commented Nov 11, 2020

smoia commented Nov 11, 2020

eurunuela left a comment

Choose a reason for hiding this comment

smoia commented Nov 11, 2020

tsalo left a comment

Choose a reason for hiding this comment

smoia commented Nov 11, 2020

eurunuela commented Nov 11, 2020

eurunuela commented Nov 11, 2020

RayStick commented Nov 11, 2020

smoia commented Nov 29, 2020

codecov bot commented Oct 14, 2020 •

edited

Loading