From 2b00c5b762d0548c49e73cf5a23c4259c63ea4e9 Mon Sep 17 00:00:00 2001 From: Manuel <5673677+mtrezza@users.noreply.github.com> Date: Sun, 16 Oct 2022 00:53:24 +0200 Subject: [PATCH] docs: change backmerge instructions in contribution docs --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e93e29b..ee058a68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -499,7 +499,7 @@ The following changes are done in the `alpha` branch, before publishing the last 3. Pull all remote branches into local branches. 4. Create a new temporary branch `backmerge` on branch `release`. 5. Create PR to merge `backmerge` into `beta`: - - PR title: ` [skip release]` where `` is the PR title of step 1. + - PR title: `refactor: ` where `` is the commit summary of step 1. The commit type needs to be `refactor`, otherwise the commit will show in the changelog of the `release` branch, once the `beta` branch is merged into release; this would a duplicate entry because the same changelog entry has already been generated when the PR was merged into the `release` branch in step 1. - PR description: (leave empty) 6. Resolve any conflicts: - During back-merging, usually all changes are preserved; current changes come from the hotfix in the `release` branch, the incoming changes come from the `beta` branch usually being ahead of the `release` branch. This makes back-merging so complex and bug-prone and is the main reason why it should be avoided if possible.