Skip to content

Commit

Permalink
doc: additional guidance about amending commits
Browse files Browse the repository at this point in the history
In my first contribution, I got the amending guidance
wrongly and amended my commit to attend some requested
changes. So I added some more lines in the docs to help the
further contributors to don't make the same mistake that I did
  • Loading branch information
Farenheith committed Dec 22, 2021
1 parent cf69964 commit 5e8f611
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/guides/contributing/pull-requests.md
Expand Up @@ -318,6 +318,8 @@ $ git commit --amend
$ git push --force-with-lease origin my-branch
```

Amend your last commit just to fix some minor mistake you may have noticed before any reviewing, though. To make the reviewing process simpler, when some changes are requested it's preferable to add a new commit.

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

0 comments on commit 5e8f611

Please sign in to comment.