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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note when to backport changes #1169

Merged
merged 6 commits into from Oct 6, 2023

Conversation

JacobCoffee
Copy link
Contributor

@JacobCoffee JacobCoffee commented Sep 26, 2023

  • Adds guidelines on what release cycles (where) should get backports of documentation and testing improvements.

Closes

Changes visualized: Dev. Cycle Versions

馃摎 Documentation preview 馃摎: https://cpython-devguide--1169.org.readthedocs.build/

@AA-Turner AA-Turner changed the title docs(#1168): add directive on when/where to backport docs and testing changes Note when to backport changes Sep 26, 2023
developer-workflow/development-cycle.rst Outdated Show resolved Hide resolved
versions.rst Outdated Show resolved Hide resolved
Copy link
Member

@AA-Turner AA-Turner 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 this Jacob. I agree with Victor's comments, this needs a few edits in the first instance.

A tip for using admonitions: they stand out and are highlighted, which means that using them must be done sparingly -- when is is most critical for a reader to be aware of a point? I think in this instance, backporting is not of sufficient import; so regular prose is fine. This is very akin to the boy who cried wolf, just in this instance replace the villagers with readers and the wolf with admonitions!

A

versions.rst Outdated Show resolved Hide resolved
developer-workflow/development-cycle.rst Outdated Show resolved Hide resolved
versions.rst Outdated Show resolved Hide resolved
@JacobCoffee
Copy link
Contributor Author

Thanks Adam, and understood. That makes sense - the use of admonitions is quite a bit different than I am used to 馃槃

@JacobCoffee
Copy link
Contributor Author

Please re-review at your earliest convenience to see if it is in line with what we want to communicate

Makefile Outdated Show resolved Hide resolved
developer-workflow/development-cycle.rst Show resolved Hide resolved
developer-workflow/development-cycle.rst Outdated Show resolved Hide resolved
developer-workflow/development-cycle.rst Outdated Show resolved Hide resolved
versions.rst Outdated Show resolved Hide resolved
versions.rst Outdated Show resolved Hide resolved
@AA-Turner
Copy link
Member

Please avoid force-pushing, it makes reviewing in the GH interface much harder. PRs are squash merged.

A

JacobCoffee and others added 2 commits September 29, 2023 13:48
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
JacobCoffee and others added 2 commits October 5, 2023 16:08
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks!

A

@hugovk hugovk merged commit c5d1b7c into python:main Oct 6, 2023
4 checks passed
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.

None yet

4 participants