Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update PR guidelines #15324

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 25, 2019
Merged

Update PR guidelines #15324

merged 1 commit into from
Sep 25, 2019

Conversation

timhoffm
Copy link
Member

PR Summary

Restructured the PR guidelines:

  • add checklists for authors and reviewers at the top
  • more detailed explanations below

Closes #15280.

This is likely not complete concerning the content. The main purpose of this PR is the restructuring. We can (and should) continue to improve topics and descriptions when this is in.


*v3.N.x*
Maintenance branch for Matplotlib 3.N. Future patch releases will be
branched from this. Supports Python 3.6+
Copy link
Member

Choose a reason for hiding this comment

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

Not true for v3.0.x branch. Also missing a final period.

Copy link
Member Author

@timhoffm timhoffm Sep 22, 2019

Choose a reason for hiding this comment

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

While still there, v3.0.x is not really active. I don't think we'll push anything to that branch anymore. Therefore I wouldn't bother with a distinction.

The other question is if stating the supported Python version is reasonable here. I've just taken that from the existing descriptions.

Copy link
Member

Choose a reason for hiding this comment

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

It does seem a bit redundant, but since PRs always target master, it's useful to know this before the backport happens.

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

Thanks for putting in this PR! Made some suggestions but also won't oppose merging since this improved the docs.


Branch selection
----------------
Checklist for PR authors
Copy link
Member

Choose a reason for hiding this comment

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

I'd call this guidelines since these aren't really things you can check off

Copy link
Member Author

Choose a reason for hiding this comment

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

That is correct. OTOH, I would like to keep a certain similarity between the names of the summary sections for authors and for reviewers.

Using "Guidelines for PR authors/reviewers" feels a bit too broad. Semantically I would like to express "Summary of things to do/check as a PR author/reviewer". I've now changed both to a shorted "Summary for PR authors/reviewers". Do you think that's suitable?

@timhoffm timhoffm force-pushed the doc-review-guide branch 3 times, most recently from ea67d43 to db5bfb8 Compare September 22, 2019 23:51
@jklymak jklymak added this to the v3.3.0 milestone Sep 25, 2019
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.

Lets merge as an improvement, and then clean up any inaccuracies...

@jklymak jklymak merged commit 6d45118 into matplotlib:master Sep 25, 2019
@timhoffm timhoffm deleted the doc-review-guide branch September 25, 2019 21:25
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.

Add pull request checklist to Reviewers Guidelines
4 participants