From d248a53206ffd7f428986ad01c3f750758521f75 Mon Sep 17 00:00:00 2001 From: Florian Wendelborn <1133858+FlorianWendelborn@users.noreply.github.com> Date: Wed, 15 Sep 2021 23:53:14 +0000 Subject: [PATCH] documentation(ci): Add Documentation for Auto-Rebase and /rebase --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 200d7d87e..cfd9fd794 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,17 @@ yarn workspace @3yourmind/kotti-ui run build yarn workspace @3yourmind/documentation run serve ``` +### Handling Rebases + +There are two workflows to help with rebasing pull requests: + +1. Rebase + Commenting `/rebase` on any pull request will trigger a GitHub Action that rebases the PR. + This is best used when attempting to rebase a PR without auto-rebase before merging. +2. Auto-Rebase + Adding the `autorebase:opt-in` label to any pull request will automatically rebase the PR as soon as it’s out-of-date. + This should preferrably be used by the author, as it requires them to be aware of having to use `git pull --rebase` + ### Linting ```bash