Skip to content

Commit

Permalink
Merge pull request learningequality#11512 from Tweniee/develop
Browse files Browse the repository at this point in the history
Tweniee/Isssue:learningequality#11361 Updated Document for PR release
  • Loading branch information
MisRob authored Nov 28, 2023
2 parents 4de6c2f + ddd86f9 commit 7c6b566
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/howtos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ These guides are step by step guides for common tasks in getting started and wor
pyenv_virtualenv
nodeenv
another_kolibri_instance
rebasing_a_pull_request
22 changes: 22 additions & 0 deletions docs/howtos/rebasing_a_pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
On certain occasions, it might be necessary to redirect a pull request from the develop branch to the latest release branch, such as `release-v*` (e.g., `release-v0.16.x` when working on version 0.16), or vice versa. This guide outlines the steps for rebasing a feature branch related to your pull request while maintaining a clean commit history.

The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below.


- Make sure you have local versions of the `develop` branch and the `release-v*` branch.
- Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively.

Locally, checkout your feature branch and run the following rebase command:

```
git rebase --onto release-v* develop
```
This command will rebase your current feature branch onto `release-v*`, removing any commits that are already present in `develop`.

After completing the rebase, you will need to force push to update your remote branch. Use the following command:

```
git push --force
```

**Caution:** Handle force-pushes with care.
6 changes: 6 additions & 0 deletions docs/howtos/rebasing_a_pull_request.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _rebasing_a_pull_request:

Rebasing a Pull Request
=======================

.. mdinclude:: ./rebasing_a_pull_request.md

0 comments on commit 7c6b566

Please sign in to comment.