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

doc: additional guidance about amending commits #41287

Merged
merged 6 commits into from
Dec 26, 2021
Merged

doc: additional guidance about amending commits #41287

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5e8f611
doc: additional guidance about amending commits
Farenheith Dec 22, 2021
758e7ab
doc: removing commit --amend recommendation
Farenheith Dec 23, 2021
712175f
doc: adding more insight about force pushing
Farenheith Dec 23, 2021
5695a24
Update doc/guides/contributing/pull-requests.md
Farenheith Dec 23, 2021
3559e44
doc: putting the new tips before 'Before you use it'
Farenheith Dec 23, 2021
98d15ba
Update doc/guides/contributing/pull-requests.md
Farenheith Dec 23, 2021
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
15 changes: 4 additions & 11 deletions doc/guides/contributing/pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,17 +306,10 @@ $ git push --force-with-lease origin my-branch
```

**Important:** The `git push --force-with-lease` command is one of the few ways
to delete history in `git`. Before you use it, make sure you understand the
risks. If in doubt, you can always ask for guidance in the pull request.

If you happen to make a mistake in any of your commits, do not worry. You can
amend the last commit (for example if you want to change the commit log).

```text
$ git add any/changed/files
$ git commit --amend
$ git push --force-with-lease origin my-branch
```
to delete history in `git`. It also complicates the review process, as it won't
allow reviewers to get a quick glance on what changed. Before you use it, make
sure you understand the risks. If in doubt, you can always ask for guidance in
the pull request.

There are a number of more advanced mechanisms for managing commits using
`git rebase` that can be used, but are beyond the scope of this guide.
Expand Down