The issue involves improving existing documentation with clear, self-contained changes.
The issue aims to enhance the manual cherry-pick instructions left when automatic cherry-picks fail by making branch names more contextual, clarifying conflict resolution, specifying repository usage, and improving link formatting. The changes are straightforward and well-defined.
When the Auto Cherry-Pick GitHub Actions workflow fails, the following comment is left on the PR:
# Checkout the wp/7.0 branch instead of trunk.
git checkout wp/7.0
# Create a new branch for your PR.
git checkout -b my-branch
# Cherry-pick the commit.
git cherry-pick d738de8b5ccd5cfc0dceee7e7c232738ebade15c
# Check which files have conflicts.
git status
# Resolve the conflict...
# Add the resolved files to the staging area.
git status
git add .
git cherry-pick --continue
# Push the branch to the repository
git push origin my-branch
# Create a PR and set the base to the wp/7.0 branch.
# See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.
These are great but there are a few things that can be improved.
my-branch, the instructions should include a contextual branch name. Above, a cherry-pick of d738de8b5ccd5cfc0dceee7e7c232738ebade15c is being attempted. The branch could should be some combination of commit SHA value, PR number, and target branch. Some possible values:
wp/7.0/cherry-pick/d738de8b5ccd5cfc0dceee7e7c232738ebade15c-from-76398cherry-pick/d738de8-to-wp-7.0-from-76398 (shortened hash)cherry-pick/76398-to-wp-7.0write access to this repo know they are free to create a PR performing the cherry-pick if they would like to.BASE braClaim this issue to let others know you're working on it. You'll earn 10 points when you complete it!