[TASK] Polish the git rebasing section in CONTRIBUTING.md
#1387
Conversation
There was a problem hiding this comment.
All changes seem like improvements to me.
I wrote this section based on rebasing as a collaborator. I think the instructions for contributors (with PRs on a fork, particularly the examples) would vary from this, and that this section really needs to be written with that target audience in mind. I'll create a ticket for it...
| @@ -142,20 +142,20 @@ To rebase a feature branch to the latest `main`: | |||
| 1. Make sure that your local copy of the repository has the most up-to-date | |||
| revisions of `main` (this is important, otherwise you may end up rebasing to | |||
| an older base point): | |||
| ```sh | |||
| git checkout main | |||
| ```bash | |||
| ```sh | ||
| git checkout main | ||
| ```bash | ||
| git switch main |
There was a problem hiding this comment.
New in Git 2.23 - additional separate commands added to declutter the overloaded functionality of checkout. Since this was released more than 5 years ago, I think it's safe to assume most people will have a version which supports this command.
| ```sh | ||
| git add *.* | ||
| ```bash | ||
| git add . |
There was a problem hiding this comment.
From what I understand, this means that git will do the file system traversal, rather than the shell, which is probably better due to being OS-independent.
|
Part of #1360