Skip to content

Commit

Permalink
minor doc story
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweniee committed Nov 20, 2023
1 parent d1b93df commit 824822a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
6 changes: 2 additions & 4 deletions docs/howtos/rebasing_a_pull_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

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.
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.


#### Before creating a new local working branch:
- 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 (that you previously created off the develop):
Locally, checkout your feature branch:
```
git checkout develop
```
After making changes to the code and committing them locally, push your working branch to your fork on GitHub

And run the following rebase command:

Expand Down
4 changes: 2 additions & 2 deletions docs/howtos/rebasing_a_pull_request.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _rebasing_a_pull_request:

Release Process with PR Rebase
========================
Rebasing a Pull Request
=======================

.. mdinclude:: ./rebasing_a_pull_request.md

0 comments on commit 824822a

Please sign in to comment.