Explain how to revert maintenance branch commits
Open
Beginner friendly
Nobody has claimed this yet.
topic-dev process
type-feature
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
It came up in https://bugs.python.org/issue32690 that it's not at all clear how to revert commits to a maintenance branch if we decide that a change shouldn't have been backported after all.
Transferring over my notes from that issue to be cleaned up and added to the dev guide:
- check out the branch of interest and ensure it's up to date
git checkout -b bpo-32690-revert-3.6-backportgit revert 9105879bfd7133ecbac67f3e9c0bacf6e477de5a- edit commit message as appropriate
- create a PR targeting the branch of interest: https://github.com/python/cpython/pull/5439
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the dev guide documentation and the maintenance-branch workflow described in the issue, including the example branch, revert command, commit-message edit, and PR target. Clean up these notes into guidance explaining how to revert an incorrectly backported commit; done means the procedure is added to the developer guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100