Wanting to merge my first PR under github - a bit of advice
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
Am I right that all I need to do is hit "Squash and Merge", tidy up the commit message, and that's it for master? This is a doc change which should probably go into 3.7 - so I presume I just add the "Needs backport" label and Miss Islington does the rest? (I assume doc fixes are still OK for 3.7 at this point?)
Is there anything else I've missed? (Do I need another approver? I'm assuming not, for a doc fix).
Sorry for the dumb questions - if I've missed a glaringly obvious explanation, feel free to let me know. I'm just a little nervous that it's *so* simple I feel I must have missed something!
Paul
PS Thanks to everyone who has worked on the new github workflow. What I've done so far has been really straightforward, and if I'm right in what I think I need to do above, then you've made the rest of the process beautifully simple, too!
Also don't forget to replace #XXXX with GH-XXXX in the commit message. I was hit by this few times.
-- Ivan
On 20 March 2018 at 20:58, Paul Moore <p.f.moore@gmail.com> wrote:
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
Am I right that all I need to do is hit "Squash and Merge", tidy up the commit message, and that's it for master? This is a doc change which should probably go into 3.7 - so I presume I just add the "Needs backport" label and Miss Islington does the rest? (I assume doc fixes are still OK for 3.7 at this point?)
Is there anything else I've missed? (Do I need another approver? I'm assuming not, for a doc fix).
Sorry for the dumb questions - if I've missed a glaringly obvious explanation, feel free to let me know. I'm just a little nervous that it's *so* simple I feel I must have missed something!
Paul
PS Thanks to everyone who has worked on the new github workflow. What I've done so far has been really straightforward, and if I'm right in what I think I need to do above, then you've made the rest of the process beautifully simple, too!
python-committers mailing list python-committers@python.org https://mail.python.org/mailman/listinfo/python-committers Code of Conduct: https://www.python.org/psf/codeofconduct/
On Tue, 20 Mar 2018 at 13:58 Paul Moore <p.f.moore@gmail.com> wrote:
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
It's pretty simple at this point. :) Obviously feel free to open an issue on the devguide to add a checklist on how to do the final commit appropriately since this should be documented somewhere.
Am I right that all I need to do is hit "Squash and Merge", tidy up the commit message, and that's it for master?
Pretty much! Just remember to tidy up the title as well like Ivan pointed out (replace "#NNNNN" with "GH-NNNN").
This is a doc change which should probably go into 3.7 - so I presume I just add the "Needs backport" label and Miss Islington does the rest? (I assume doc fixes are still OK for 3.7 at this point?)
Just make sure to add the labels before the merge. Then after the merge the issue will get a comment pointing to the backported PR. Go over there and approve the new PR, then miss-islington will handle the final merge.
Is there anything else I've missed? (Do I need another approver? I'm assuming not, for a doc fix).
Not really; it's mostly outlined above.
Sorry for the dumb questions - if I've missed a glaringly obvious explanation, feel free to let me know. I'm just a little nervous that it's *so* simple I feel I must have missed something!
:) Yeah, it's like when your tests pass the first time. It seems too good to be true. :)
Paul
PS Thanks to everyone who has worked on the new github workflow. What I've done so far has been really straightforward, and if I'm right in what I think I need to do above, then you've made the rest of the process beautifully simple, too!
We have tried. :)
On 21 March 2018 at 06:58, Paul Moore <p.f.moore@gmail.com> wrote:
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
You didn't miss it - https://devguide.python.org/committing/ is still pretty much written for the old approach of merging on the command line.
So a devguide issue would definltely be appropriate, and if you're so inclined, even a PR with the docs that you wish had existing when you looked for them :)
Cheers, Nick.
-- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia
On 21 March 2018 at 12:42, Nick Coghlan <ncoghlan@gmail.com> wrote:
On 21 March 2018 at 06:58, Paul Moore <p.f.moore@gmail.com> wrote:
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
You didn't miss it - https://devguide.python.org/committing/ is still pretty much written for the old approach of merging on the command line.
So a devguide issue would definltely be appropriate, and if you're so inclined, even a PR with the docs that you wish had existing when you looked for them :)
I'll certainly try to find some time to put something together. For now, I've raised https://github.com/python/devguide/issues/347 to track it.
Paul
Some steps were written here: https://devguide.python.org/gitbootcamp/#accepting-and-merging-a-pull-reques...
And the section right after explains the backport.
I guess it needs reorganizing.
Top posted from my phone while literally on a beach.
On Wed, Mar 21, 2018, 7:57 AM Paul Moore <p.f.moore@gmail.com> wrote:
On 21 March 2018 at 06:58, Paul Moore <p.f.moore@gmail.com> wrote:
Hi, Cheryl Sabella kindly migrated a patch I'd put on bpo some time ago but forgotten about onto github. The PR (#6158) is ready to go (I think) but this is the first time since the migration to github that I've done a merge, and I'm not quite sure what the workflow is :-( I didn't see much in the devguide (which covers how to write a PR, how to test it etc, but not so much how to merge it, unless I missed something, or it's so simple that the little I did find is all that's needed!)
You didn't miss it - https://devguide.python.org/committing/ is still
On 21 March 2018 at 12:42, Nick Coghlan <ncoghlan@gmail.com> wrote: pretty
much written for the old approach of merging on the command line.
So a devguide issue would definltely be appropriate, and if you're so inclined, even a PR with the docs that you wish had existing when you looked for them :)
I'll certainly try to find some time to put something together. For now, I've raised https://github.com/python/devguide/issues/347 to track it.
Paul
python-committers mailing list python-committers@python.org https://mail.python.org/mailman/listinfo/python-committers Code of Conduct: https://www.python.org/psf/codeofconduct/
On 21 March 2018 at 14:02, Mariatta Wijaya <mariatta.wijaya@gmail.com> wrote:
Some steps were written here: https://devguide.python.org/gitbootcamp/#accepting-and-merging-a-pull-reques...
And the section right after explains the backport.
Thanks Mariatta - that's exactly what I was looking for.
I guess it needs reorganizing.
It's depressing how often the problem is not about providing the information, but about helping people find it. I was *almost* there - I remember skimming the pages about git, but as I know git itself, I was assuming it was about git for people who didn't know it, rather than "how the CPython workflow uses git" and missed that bit. I'll see if I can think of a way of making it a bit more obvious.
Top posted from my phone while literally on a beach.
I'm jealous :-)
Paul
participants (5)
-
Brett Cannon -
Ivan Levkivskyi -
Mariatta Wijaya -
Nick Coghlan -
Paul Moore