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.

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

doc: show how to use to git to submit smaller and faster PRs #83839

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 15 additions & 0 deletions doc/contribute/contributor_expectations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ benefits:

- Easier to revert if the PR breaks functionality.

- More test coverage because CI does not test intermediate commits in a PR;
only PRs as a whole.

- Mixing different authors in the same pull request adds :ref:`extra
complications <modifying_contributions>`.

- When independent of each other, smaller PRs can progress
*concurrently*. Disagreements, nitpicks and other delays in one place
do not hold back everything else (this type of faster, concurrent
workflow is known as "Stacked Diffs").

The :ref:`Contribution workflow` section shows how to use git to submit
several, smaller pull requests. This does not require creating and
managing multiple git branches.

.. note::
This page does not apply to draft PRs which can have any size, any number of
commits and any combination of smaller PRs for testing and preview purposes.
Expand Down
18 changes: 17 additions & 1 deletion doc/contribute/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -838,8 +838,24 @@ workflow here:

git push origin fix_comment_typo

#. Avoid submitting a large number of commits in a single pull request,
see :ref:`contributor-expectations` why. It is tempting to submit
all at once and hope that everything will be merged faster but the
opposite effect is generally achieved. Submitting several, smaller
pull requests does *not* require creating and managing local git
branches::

git push origin big_work~15:refs/heads/big_work_part1

In this example, the 15 most recent commits in the ``big_work`` local
branch are *omitted* from the ``big_work_part1`` remote branch and pull
request. This "Stacked Diffs" technique lets you submit part 1 and get
reviews started long before the rest is ready. When smaller parts are
independent of each other, rotating them with ``git rebase -i`` (see below)
lets you submit them concurrently which is even faster.

#. In your web browser, go to your forked repo and click on the
``Compare & pull request`` button for the branch you just worked on and
``Compare & pull request`` button for the branch you just pushed on and
you want to open a pull request with.

#. Review the pull request changes, and verify that you are opening a pull
Expand Down
Loading