Skip to content

Commit b48c7fc

Browse files
dbkinderandrewboie
authored andcommitted
doc: add note about force pushes to contrib guide
Let folks know that using amend and force pushes for adding review changes is the recommend method for contributing to the project, but it can cause some unexpected behavior from GitHub. Signed-off-by: David B. Kinder <[email protected]>
1 parent 6346cc1 commit b48c7fc

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/contribute/index.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,15 @@ workflow here:
540540
By force pushing your update, your original pull request will be updated
541541
with your changes so you won't need to resubmit the pull request.
542542

543+
.. note:: While amending commits and force pushing is a common review model
544+
outside GitHub, and the one recommended by Zephyr, it's not the main
545+
model supported by GitHub. Forced pushes can cause unexpected behavior,
546+
such as not being able to use "View Changes" buttons except for the last
547+
one - GitHub complains it can't find older commits. You're also not
548+
always able to compare the latest reviewed version with the latest
549+
submitted version. When rewriting history GitHub only guarantees access
550+
to the latest version.
551+
543552
#. If the CI run fails, you will need to make changes to your code in order
544553
to fix the issues and amend your commits by rebasing as described above.
545554
Additional information about the CI system can be found in
@@ -579,7 +588,7 @@ does and why it's needed. A change summary of ``"Fixes stuff"`` will be rejected
579588

580589
.. warning::
581590
An empty change summary body is not permitted. Even for trivial changes, please
582-
include a summary body in the commmit message.
591+
include a summary body in the commit message.
583592

584593
The description body of the commit message must include:
585594

0 commit comments

Comments
 (0)