From 5e8f611d5389e0dde8de6603f780ba365096b14e Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Wed, 22 Dec 2021 18:16:32 -0300 Subject: [PATCH] doc: additional guidance about amending commits 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 --- doc/guides/contributing/pull-requests.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 228b9839ca1f8b..1ad39ef8472b18 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -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.