-
-
Notifications
You must be signed in to change notification settings - Fork 723
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
Clarify where docs fixes can be backported #1069
Comments
I'm not sure where it's formally written down specifically, but AFAIK the de-facto policy has been that docs changes that don't touch the code are always backported to bugfix branches so long as they aren't inapplicable to the branch in question (or would result in tricky merge conflicts that would need to be manually resolved), because:
By contrast, for security branches, general and RM practice as discussed on Discord has been to only backport docs changes relevant to the security/etc. changes that the RM has approved for that branch, as well as any other security-relevant docs changes (rare, but in a recent example, fixing a maliciously-hijacked URL). Of course, its ultimately up to the RMs what goes in to these branches since everything is manually approved, AFAIK. AFAIK, nothing above conflicts with this, it just doesn't comment on docs changes specifically. However, it would probably be a good idea to include an explicit note to this effect summarizing this (and maybe a PSA to the core dev team), as it often comes up on PRs and I'm not sure everyone is uniformly aware of and consistently applying the backport labels—it's not that hard for anyone not dealing with multiple docs PRs every day like we are to not remember to add them. |
Looks like the detailed general policy should be described in Development cycle, and the status page should be a quick overview of the current state of the branches. |
Ah, okay. In that case, we could just reword the first three here to say |
That sounds good! |
@JelleZijlstra has written some notes at https://jellezijlstra.github.io/cpython#backporting Related: #503 asking about backporting in general. |
The related #1169 has been merged. For this issue, do we still need some changes? |
The status key for branches has lists of changes that can go in, and the lists look exclusive:
This makes it a bit awkward to backport docs changes, especially now that the lists are included in the tag descriptions.
AFAIK, docs fixes don't need RM approval in feature, prerelease and bugfix branches. (Security branches are locked so any change needs the RM in the loop.)
Is that right, @pablogsal @Yhg1s ?
The text was updated successfully, but these errors were encountered: