Skip to content

Commit 87de350

Browse files
authored
Add details about merging pull requests (#1808)
1 parent 109d6d0 commit 87de350

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

core-team/committing.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ to enter the public source tree. Ask yourself the following questions:
3535
Check :ref:`pull-request-lifecycle` and :ref:`helptriage` to review what
3636
is expected of a pull request.
3737

38-
* **Does the change break backwards-compatibility without a strong reason?**
38+
* **Does the change break backwards compatibility without a strong reason?**
3939
:ref:`Run the entire test suite <runtests>` to make sure that everything
4040
still passes. If there is a change to the semantics, then there needs to
4141
be a strong reason, because it will cause some peoples' code to break.
@@ -79,6 +79,31 @@ to enter the public source tree. Ask yourself the following questions:
7979
:ref:`what-s-new-and-news-entries`
8080

8181

82+
Merging the pull request
83+
------------------------
84+
85+
Once the pull request is ready, you (the core team member) can merge it.
86+
If other people have been substantially involved in the review, it can be good
87+
to wait for their approval even if a core team member has already approved the
88+
pull request.
89+
90+
The CPython repo is configured to only accept squashes. You will squash the
91+
pull request.
92+
93+
Commit message
94+
^^^^^^^^^^^^^^
95+
96+
GitHub defaults the squashed commit message to a combined list of all of the
97+
individual commit messages in the pull request. Do not leave those. They often
98+
are too noisy and provide little context, especially since devs know their
99+
work will be eventually squashed, so intermediate commit messages while
100+
working on the pull request are not interesting.
101+
102+
If you think it is important, you can summarize the collaborative work that
103+
went into the pull request, but it is not necessary. The pull request and/or
104+
original issue are still available for detailed investigations of history.
105+
106+
82107
Working with Git_
83108
-----------------
84109

0 commit comments

Comments
 (0)