Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for rebasing in git workflow docs #299

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Add instructions for rebasing in git workflow docs #299

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca6029c
Updated docs to use rebasing instead of merging for keeping fork upda…
bourque Dec 21, 2023
7cbf984
Added pulling instructions back in, giving people the option of eithe…
bourque Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/source/development-guide/style-guide/git-and-github-workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,18 @@ Keeping your fork updated
^^^^^^^^^^^^^^^^^^^^^^^^^

You can keep your personal fork up-to-date with the ``IMAP-Science-Operations-Center`` ``imap_processing`` repository by
fetching and pulling the ``upstream`` remote:
either fetching and rebasing with the ``upstream`` remote, or fetching and pulling with the ``upstream`` remote:

.. code-block:: bash

git checkout dev
git fetch upstream
git rebase -i upstream/dev

or

.. code-block:: bash

git fetch upstream dev
git pull upstream/dev

Expand All @@ -137,4 +144,4 @@ nominal workflow for contributing:
git fetch <username>
git checkout -b <branchname> <username>/<branchname>
# Make some changes via add/commit cycle
git push <username> <branchname>
git push <username> <branchname>