Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Mention labels and milestones in PR review guidelines #15252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2019

Conversation

timhoffm
Copy link
Member

PR Summary

Even though reviewers should know, that information was missing.

doc/devel/coding_guide.rst Outdated Show resolved Hide resolved
doc/devel/coding_guide.rst Outdated Show resolved Hide resolved
doc/devel/coding_guide.rst Outdated Show resolved Hide resolved
@timhoffm timhoffm force-pushed the doc-milestone branch 3 times, most recently from 7e47918 to e2d22ec Compare September 12, 2019 18:26
@timhoffm
Copy link
Member Author

@story645 Thanks, I appreciate your care for the detail of my wording! It's sometimes hard to find the right words as a non-native speaker. Please continue to correct if you see that I'm writing something clumsy or strange. 😄

@story645
Copy link
Member

No problem, feel free to tag me on your doc PRs!


* the next bugfix release for bugfixes; e.g. ``v.3.X.Y``

Primary PRs should still target the master branch. PRs milestoned for
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean here by primary. Are you taking about most PRs? And you don't need the still here.

@@ -47,6 +47,19 @@ PR Review guidelines
* If you have commit rights, then you are trusted to use them. Please
help review and merge PRs!

* Tag the PR with descriptive labels. See the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if contributors without triage rights can add labels, even on their own PRs. If they can't, then qualify this statement: If you have triage writes, tag the PR...

@timhoffm timhoffm force-pushed the doc-milestone branch 2 times, most recently from 84c5d78 to bbbe169 Compare September 13, 2019 06:26
@story645
Copy link
Member

Almost everytime I've hit merge, something has gone horribly wrong so I was wondering if somebody could walk me through it.

@ImportanceOfBeingErnest
Copy link
Member

There is no v3.2-doc branch yet, so what should this PR be milestoned to?

@timhoffm
Copy link
Member Author

Technically, this would go for master. I'll try to remember and trigger a backport once we have a v3.2-doc branch.

OTOH, we could also just flag this as v3.2.0 and sneak it into the unpublished 3.2 release. Should be uncritical because it's doc-only. And v3.2-doc would branch from v3.2.0 anyway.

@timhoffm
Copy link
Member Author

@story645 happy to walk you through. I was just about to say that it's easy, but this again is a bit special because we don't have the target branch yet to which it would usually go. 😏 Will get back once we decide what to do.

@ImportanceOfBeingErnest
Copy link
Member

So currently this talks about changes to the source code. But there are two other kind of PRs,

  • changes to .py files which only touch the docstrings
  • changes to the documentation (mostly .rst files, etc.)

and for those it's not entirely clear how to milestone them or which to backport where.

@timhoffm
Copy link
Member Author

@ImportanceOfBeingErnest good point! Clarified these points.

@timhoffm timhoffm force-pushed the doc-milestone branch 4 times, most recently from 88da735 to f9f3ae6 Compare September 14, 2019 10:46
Copy link
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is now very clear.
It seems @story645 wanted to use this as learning example for merging, I will leave it to her to hit the green button.

@ImportanceOfBeingErnest ImportanceOfBeingErnest added this to the v3.2.0 milestone Sep 15, 2019
@timhoffm
Copy link
Member Author

@story645

This PR itself improves on the guidelines how to review 😄
https://25068-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/devel/coding_guide.html

Nevertheless, here's a condensed checklist of the thing to check before merging:

  • Check that the PR targets the master branch
  • Check/set labels
  • Check/set milestone
  • Check that tests still pass
  • Check that the PR does not have excessive commits. One or a few semantically grouped commits should do (in particular less experienced github users tend to commit all their changes in sequence). If there are too many, ask the author to squash, or use "Squash and Merge" button in the github UI.

If all is ok, merge! 😄
This PR should fulfill all above points, but convince yourself.

If you would like to get more in into approving / merging PRs and would like some guidance/second pair of eyes, feel free to ping me on any PR you would like to take on. I'm happy to help (and maybe we could even improve this reviewers guide as we go along).

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is hepful plus or minus the suggestion above.

doc/devel/coding_guide.rst Show resolved Hide resolved
@story645
Copy link
Member

@timhoffm I'm thinking what about a followup PR that has that checklist at the top of the reviewers guidelines? Also thanks for all your help!

@story645 story645 merged commit 8d17939 into matplotlib:master Sep 17, 2019
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 17, 2019
@timhoffm timhoffm deleted the doc-milestone branch September 17, 2019 06:44
dstansby added a commit that referenced this pull request Sep 17, 2019
…252-on-v3.2.x

Backport PR #15252 on branch v3.2.x (Mention labels and milestones in PR review guidelines)
@timhoffm
Copy link
Member Author

I'm thinking what about a followup PR that has that checklist at the top of the reviewers guidelines?

@story645 I was just thinking the same thing when I wrote up the checklist 😄.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.