From 01203fd5a11ff41b58e691c4cdc5c7b75b4cd01d Mon Sep 17 00:00:00 2001 From: Tweniee Date: Wed, 8 Nov 2023 11:57:20 +0530 Subject: [PATCH 1/2] Tweniee/Issue11361 documentation for rebase update --- docs/getting_started.rst | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index f464bd42d0c..320d101c488 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -487,23 +487,41 @@ For more information, see the next section on :doc:`/manual_testing/index`. Submitting a pull request ------------------------- -Here's a very simple scenario. Below, your remote is called ``origin``, and Learning Equality is ``le``. +Here's a very simple scenario. Below, your remote is called ``origin``, Learning Equality is ``le``, and ``release-v*`` is current release. -First, create a new local working branch: + + +Create a new local working branch: + - Make sure you have local versions of the Learning Equality `develop` branch and the Learning Equality `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. .. code-block:: bash # checkout the upstream develop branch - git checkout le/develop - # make a new feature branch - git checkout -b my-awesome-changes + git checkout develop After making changes to the code and committing them locally, push your working branch to your fork on GitHub: .. code-block:: bash - git push origin my-awesome-changes + git push origin develop + + +Run Rebase Command + - Run the following rebase command: + .. code-block:: bash + + git rebase --onto release-v* develop + + This command will rebase your current branch ``(develop)`` onto `release-v*`, removing any commits that are already present in `develop`. +Force Push + - After completing the rebase, you will need to force push to update your remote branch. Use the following command: + .. code-block:: bash + + git push --force + + Go to Kolibri's `GitHub page `__, and create a the new pull request. .. note:: From e5132e1205de3f387c83d08218413cd60412965f Mon Sep 17 00:00:00 2001 From: Abhishek upadhyay <93429474+Tweniee@users.noreply.github.com> Date: Wed, 8 Nov 2023 12:07:37 +0530 Subject: [PATCH 2/2] Tweniee/#11361 updated documentation for PR --- docs/getting_started.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 320d101c488..0b86478787b 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -491,9 +491,9 @@ Here's a very simple scenario. Below, your remote is called ``origin``, Learning -Create a new local working branch: - - Make sure you have local versions of the Learning Equality `develop` branch and the Learning Equality `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. +Make sure you have local versions of the Learning Equality ``develop`` branch and the Learning Equality ``release-v*`` branch and ensure that both branches are up to date. + +For this guide, we'll assume they are named ``develop`` and ``release-v*`` branches, respectively. .. code-block:: bash @@ -508,15 +508,15 @@ After making changes to the code and committing them locally, push your working Run Rebase Command - - Run the following rebase command: - .. code-block:: bash - - git rebase --onto release-v* develop + +.. code-block:: bash + + git rebase --onto release-v* develop - This command will rebase your current branch ``(develop)`` onto `release-v*`, removing any commits that are already present in `develop`. +This command will rebase your current branch ``(develop)`` 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: -Force Push - - After completing the rebase, you will need to force push to update your remote branch. Use the following command: .. code-block:: bash git push --force