Skip to content
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

PEP 1: Update "issue tracker" to link to GitHub Issues #2568

Merged
merged 4 commits into from
May 2, 2022

Conversation

itamaro
Copy link
Contributor

@itamaro itamaro commented May 2, 2022

with all the issues migrated to GitHub Issues, it makes sense now for PEP-1 to point to GitHub Issues over BPO

with all the issues migrated to GitHub Issues, it makes sense now for PEP-1 to point to GitHub Issues over BPO
@itamaro itamaro requested review from warsaw and ncoghlan as code owners May 2, 2022 21:44
@Rosuav
Copy link
Contributor

Rosuav commented May 2, 2022

Yep, seems good. 👍 Might also be worth saying "pull request" rather than "patch submission".

@CAM-Gerlach CAM-Gerlach changed the title PEP 001: Update "issue tracker" to link to GitHub Issues PEP 1: Update "issue tracker" to link to GitHub Issues May 2, 2022
@itamaro
Copy link
Contributor Author

itamaro commented May 2, 2022

Might also be worth saying "pull request" rather than "patch submission".

oh, good call!

this could use a little wordsmithing.

the current sentence is:

Small enhancements or patches often don't need
a PEP and can be injected into the Python development workflow with a
patch submission to the Python issue tracker.

I think changing "patch submission" to "pull request" would cause more confusion, since pull requests are not created via the issue tracker (as perhaps patches were attached to BPO issue in the past).

to make this accurate, we need to say something along these lines:

Small enhancements or changes often don't need a PEP and
can be integrated into the Python development workflow by reporting
an issue to the Python issue tracker and submitting a pull request.

if this looks good, I'll update the PR with the changes.

@JelleZijlstra
Copy link
Member

@itamaro that wording sounds good to me.

@Rosuav
Copy link
Contributor

Rosuav commented May 2, 2022

On GitHub, the issue tracker manages pull requests too, so it's not terribly wrong. What about this slight change?

Small enhancements or changes often don't need a PEP and
can be integrated into the Python development workflow by reporting
an issue to the Python issue tracker and/or submitting a pull request.

rephrase a sentence to more accurately describe the current GitHub-based workflow
@itamaro
Copy link
Contributor Author

itamaro commented May 2, 2022

thanks for the feedback and suggestions - update the PR and added a link to GitHub pull requests too

@CAM-Gerlach
Copy link
Member

That's better, though IMO that sentence can be made a lot simpler, and I don't know if its wise to push users directly to pull requests since any non-trivial change requires an issue. Also, due to the automatic re-wrapping to fit the hard breaks, it ends up touching a fairly substantial number of lines and is hard to see what was actually modified,

What about this change as implemented on this branch instead?

@itamaro
Copy link
Contributor Author

itamaro commented May 2, 2022

What about this change as implemented on this branch instead?

that looks good to me

@AA-Turner
Copy link
Member

s/Small enhancements/Most enhancements/ in either version -- de facto only substantive changes go through the PEP process.

A

@AA-Turner
Copy link
Member

AA-Turner commented May 2, 2022

+0 to Cam's wording over the one proposed in this PR, +1 to the change in general.

A

@CAM-Gerlach
Copy link
Member

After in-person discussion with @itamaro , he asked me to go ahead and push a commit with a slightly modified form of my proposed revision.

pep-0001.txt Outdated Show resolved Hide resolved
@AA-Turner AA-Turner merged commit 4b04a2b into python:main May 2, 2022
@AA-Turner
Copy link
Member

Thanks @itamaro!

A

@Rosuav

This comment was marked as resolved.

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

Successfully merging this pull request may close these issues.

5 participants