-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Update PR guidelines #15324
Conversation
doc/devel/coding_guide.rst
Outdated
|
||
*v3.N.x* | ||
Maintenance branch for Matplotlib 3.N. Future patch releases will be | ||
branched from this. Supports Python 3.6+ |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
6e6766b
to
54d1197
Compare
There was a problem hiding this 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.
doc/devel/coding_guide.rst
Outdated
|
||
Branch selection | ||
---------------- | ||
Checklist for PR authors |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
ea67d43
to
db5bfb8
Compare
db5bfb8
to
558e74a
Compare
There was a problem hiding this 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...
PR Summary
Restructured the PR guidelines:
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.