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

bpo-40441: Fix plural typo in documentation #19799

Merged
merged 1 commit into from Apr 29, 2020
Merged

bpo-40441: Fix plural typo in documentation #19799

merged 1 commit into from Apr 29, 2020

Conversation

alexpovel
Copy link
Contributor

@alexpovel alexpovel commented Apr 29, 2020

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 29, 2020
@remilapeyre
Copy link
Contributor

remilapeyre commented Apr 29, 2020

Hi @alexpovel, thanks for improving the documentation. Please change the title of the Pull Request to "bpo-40441: Fix plural typo in documentation"

@nanjekyejoannah nanjekyejoannah changed the title Fix plural typo in documentation bpo-40441: Fix plural typo in documentation Apr 29, 2020
@nanjekyejoannah nanjekyejoannah merged commit fd33cdb into python:master Apr 29, 2020
4 checks passed
@nanjekyejoannah
Copy link
Member

nanjekyejoannah commented Apr 29, 2020

Thanks @alexpovel for your contribution. I hope you also noted @remilapeyre 's comment on how PR titles are written.

@alexpovel
Copy link
Contributor Author

alexpovel commented Apr 30, 2020

Thank you for your very swift response. I read and was aware of the naming scheme, however something tripped me up. When creating an issue in the issue tracker, one must (should?) give a link to a PR. As such, the link to a PR has to be known before creating an issue. So the PR cannot be titled correctly, because the issue tracker number is not known yet.

The same logic seems to apply to git commits, which is why my commit message did not have a bpo number (simple typo PRs do not require an issue in the first place, but I am interested in how to resolve this otherwise).

It seems like creating the issue, thus getting a number, then working on the issue, committing and then creating a PR, then afterwards adding a link to the PR is the way to go?

@remilapeyre
Copy link
Contributor

remilapeyre commented Apr 30, 2020

It seems like creating the issue, thus getting a number, then working on the issue, committing and then creating a PR, then afterwards adding a link to the PR is the way to go?

Yes exactly, having the issue first also helps if some discussion is needed. Note that only the PR title has a specific naming scheme, you can write your commits anyway you want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants