Skip to content

Commit 4207d69

Browse files
authored
Update wording on committing.rst. (#262)
* Update wording on committing.rst. * Fix typo.
1 parent 49a68b8 commit 4207d69

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

committing.rst

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
.. _committing:
22

3-
Committing and Pushing Changes
4-
==============================
3+
Accepting Pull Requests
4+
=======================
55

6-
Is the change ready for committing?
7-
-----------------------------------
6+
This page is aimed to core developers, and covers the steps required to
7+
accept, merge, and possibly backport a pull request on the main repository.
88

9-
Before a change is committed, you must make sure it is ready to enter the
10-
public source tree. Draft commits are prohibited. Therefore, you must
11-
ensure your changes fulfill several mandatory criteria.
9+
Is the PR ready to be accepted?
10+
-------------------------------
1211

13-
When working a pull request on GitHub, use the following as a checklist of
14-
what to check for before merging (details of various steps can be found
15-
later in this document):
12+
Before a PR is accepted, you must make sure it is ready to enter the public
13+
source tree. Use the following as a checklist of what to check for before
14+
merging (details of various steps can be found later in this document):
1615

1716
#. Has the submitter signed the CLA?
1817
(delineated by a label on the pull request)
@@ -40,14 +39,14 @@ Does the test suite still pass?
4039
'''''''''''''''''''''''''''''''
4140

4241
You must :ref:`run the whole test suite <runtests>` to ensure that it
43-
passes before pushing any code changes.
42+
passes before merging any code changes.
4443

4544
.. note::
4645
You really need to run the **entire** test suite. Running a single test
47-
is not enough as your changes may have unforeseen effects on other tests
46+
is not enough as the changes may have unforeseen effects on other tests
4847
or library modules.
4948

50-
Running the entire test suite doesn't guarantee that your changes
49+
Running the entire test suite doesn't guarantee that the changes
5150
will pass the :ref:`continuous integration <buildbots>` tests, as those
5251
will exercise more possibilities still (such as different platforms or
5352
build options). But it will at least catch non-build specific,
@@ -93,6 +92,8 @@ making a complete patch.
9392
Commit Style
9493
------------
9594

95+
.. move this to pullrequest
96+
9697
Once a change patch is ready and tested, it can be committed to the repository.
9798
We usually prefer to put a whole feature or bugfix into a single commit, but no
9899
more. In particular:
@@ -240,6 +241,8 @@ unprocessed.)
240241
Commit Messages
241242
---------------
242243

244+
.. move to pullrequest
245+
243246
Every commit has a commit message to document why a change was made and to
244247
communicate that reason to other core developers. Python core developers have
245248
developed a standard way of formatting commit messages that everyone is

0 commit comments

Comments
 (0)