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

Jump to bottom

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

merged 2 commits into from
Dec 21, 2023

Conversation

bourque
Copy link
Collaborator

@bourque bourque commented Dec 21, 2023

Change Summary

Overview

Updates the git workflow docs to use rebasing instead of pulling/merging, as I think that is our preferred method? (Might be opening a can of worms here 😅)

Updated Files

-docs/source/development-guide/style-guide/git-and-github-workflow.rst

  • Updated 'keeping your fork updated' section to use rebasing

@bourque bourque added the Repo: Documentation Improvements or additions to documentation label Dec 21, 2023
@bourque bourque requested a review from a team December 21, 2023 17:27
@bourque bourque self-assigned this Dec 21, 2023
@bourque bourque requested review from sdhoyt, greglucas, tech3371, bryan-harter, laspsandoval, GFMoraga and maxinelasp and removed request for a team December 21, 2023 17:27
laspsandoval
laspsandoval approved these changes Dec 21, 2023
View reviewed changes
Copy link
Contributor

@laspsandoval laspsandoval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@maxinelasp
Copy link
Contributor

Maybe we can leave the instructions for git pull in there and just add this information as another option? I find rebasing to be quite tricky and I wouldn't necessarily want people who are inexperienced with git to use it, since it's easy to wreck stuff.

@bourque bourque force-pushed the update-git-workflow-docs branch from dcadb83 to 7cbf984 Compare December 21, 2023 22:34
@bourque bourque changed the title Use rebasing instead of merging in git workflow Add instructions for rebasing in git workflow docs Dec 21, 2023
@bourque bourque merged commit 6309146 into IMAP-Science-Operations-Center:dev Dec 21, 2023
14 checks passed
@bourque bourque deleted the update-git-workflow-docs branch December 21, 2023 22:41
laspsandoval pushed a commit to laspsandoval/imap_processing that referenced this pull request Apr 2, 2024
@bourque
Merge pull request IMAP-Science-Operations-Center#299 from bourque/up…
28333b7 
…date-git-workflow-docs

Add instructions for rebasing in git workflow docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laspsandoval laspsandoval laspsandoval approved these changes

@tech3371 tech3371 tech3371 approved these changes

@sdhoyt sdhoyt Awaiting requested review from sdhoyt sdhoyt was automatically assigned from IMAP-Science-Operations-Center/imap-sdc

@greglucas greglucas Awaiting requested review from greglucas greglucas was automatically assigned from IMAP-Science-Operations-Center/imap-sdc

@bryan-harter bryan-harter Awaiting requested review from bryan-harter bryan-harter was automatically assigned from IMAP-Science-Operations-Center/imap-sdc

@GFMoraga GFMoraga Awaiting requested review from GFMoraga GFMoraga was automatically assigned from IMAP-Science-Operations-Center/imap-sdc

@maxinelasp maxinelasp Awaiting requested review from maxinelasp maxinelasp was automatically assigned from IMAP-Science-Operations-Center/imap-sdc

Assignees

@bourque bourque

Labels
Repo: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bourque @maxinelasp @tech3371 @laspsandoval