Skip to content

Commit 0ad84cd

Browse files
nedbathugovkezio-melotti
authored
More uniform terminology: patch and changeset #1443 (#1446)
Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Ezio Melotti <[email protected]>
1 parent 293785f commit 0ad84cd

15 files changed

+48
-48
lines changed

contrib/code/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Code contributions
99
|purpose|
1010

1111
* Code setup and building (more complex stuff, delta from basic setup above)
12-
* More git bootcamp (patches, etc)
12+
* More Git bootcamp (pull requests, etc)
1313
* Lifecycle of a code pull request
1414
* Development workflow (from devguide)
1515
* Testing and buildbots (from devguide)

core-developers/become-core-developer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How to become a core developer
88
What it takes
99
=============
1010

11-
When you have consistently contributed patches which meet quality standards
11+
When you have consistently made contributions which meet quality standards
1212
without requiring extensive rewrites prior to being committed,
1313
you may qualify for commit privileges and become a core developer of Python.
1414
You must also work well with other core developers (and people in general)

core-developers/committing.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ to enter the public source tree. Ask yourself the following questions:
3131
* **Do the checks on the pull request show that the test suite passes?**
3232
Make sure that all of the status checks are passing.
3333

34-
* **Is the patch in a good state?**
35-
Check :ref:`patch` and :ref:`helptriage` to review what is expected of
36-
a patch.
34+
* **Is the pull request in a good state?**
35+
Check :ref:`pull-request-lifecycle` and :ref:`helptriage` to review what
36+
is expected of a pull request.
3737

38-
* **Does the patch 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.
@@ -165,7 +165,7 @@ number since it is part of the file name. You can use
165165
entry::
166166

167167
Fix warning message when :func:`os.chdir` fails inside
168-
:func:`test.support.temp_cwd`. Patch by Chris Jerdonek.
168+
:func:`test.support.temp_cwd`. Contributed by Chris Jerdonek.
169169

170170
The inline Sphinx roles like ``:func:`` can be used help readers
171171
find more information. You can build HTML and verify that the
@@ -182,7 +182,7 @@ As a core developer, you have the ability to push changes to the official
182182
Python repositories, so you need to be careful with your workflow:
183183

184184
* **You should not push new branches to the main repository.** You can
185-
still use them in the fork that you use for the development of patches.
185+
still use them in the fork that you use for your own development.
186186
You can also push these branches to a separate public repository
187187
for maintenance work before it is integrated into the main repository.
188188

core-developers/motivations.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,11 @@ Goals of this page
279279

280280
The `issue metrics`_ automatically collected by the CPython issue tracker
281281
strongly suggest that the current core development process is bottlenecked on
282-
core developer time - this is most clearly indicated in the first metrics graph,
283-
which shows both the number of open issues and the number of patches awaiting
282+
core developer time. This is most clearly indicated in the first metrics graph,
283+
which shows both the number of open issues and the number of pull requests awaiting
284284
review growing steadily over time, despite CPython being one of the most
285285
active open source projects in the world. This bottleneck then impacts not only
286-
resolving open issues and applying submitted patches, but also the process of
286+
resolving open issues and accepting submitted pull requests, but also the process of
287287
identifying, nominating and mentoring new core developers.
288288

289289
The core commit statistics monitored by sites like `OpenHub`_ provide a good

core-developers/responsibilities.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Responsibilities
77
As contributors to the CPython project, our shared responsibility is to
88
collaborate constructively with other contributors, including core developers.
99
This responsibility covers all forms of contribution, whether that's submitting
10-
patches to the implementation or documentation, reviewing other peoples'
11-
patches, triaging issues on the issue tracker, or discussing design and
10+
pull requests to the implementation or documentation, reviewing other peoples'
11+
pull requests, triaging issues on the issue tracker, or discussing design and
1212
development ideas on the core
1313
:ref:`communication channels <communication-channels>`.
1414

@@ -68,7 +68,7 @@ the ability to license your code means it can be put under the PSF license so
6868
it can be legally distributed with Python.
6969

7070
This is a very important step! Hopefully you have already submitted a
71-
contributor agreement if you have been submitting patches. But if you have not
71+
contributor agreement if you have been submitting pull requests. But if you have not
7272
done this yet, it is best to do this ASAP, probably before you even do your
7373
first commit so as to not forget. Also do not forget to enter your GitHub
7474
username into your details on the issue tracker.

developer-workflow/development-cycle.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Commits to security branches are to be coordinated with the release manager
118118
for the corresponding feature version, as listed in the :ref:`branchstatus`.
119119
Merging of pull requests to security branches is restricted to release managers.
120120
Any release made from a security branch is source-only and done only when actual
121-
security patches have been applied to the branch. These releases have a
121+
security fixes have been applied to the branch. These releases have a
122122
**micro version** number greater than the last **bugfix** release.
123123

124124
.. _eolbranch:
@@ -151,8 +151,8 @@ Pre-alpha
151151

152152
The branch is in this stage when no official release has been done since
153153
the latest final release. There are no special restrictions placed on
154-
commits, although the usual advice applies (getting patches reviewed, avoiding
155-
breaking the buildbots).
154+
commits, although the usual advice applies (getting pull requests reviewed,
155+
avoiding breaking the buildbots).
156156

157157
.. _alpha:
158158

developer-workflow/psrt.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -68,24 +68,24 @@ severity, advisory text, and fixes.
6868
* Affected components and APIs. The module, function, class, or method must be specified so users can
6969
search their codebase for usage. For issues affecting the entire project, this can be omitted.
7070

71-
* Mitigations for the vulnerability beyond upgrading to a patched version, if applicable.
71+
* Mitigations for the vulnerability beyond upgrading to a fixed version, if applicable.
7272

7373
This can all be done within the GitHub Security Advisory UI for easier collaboration between reporter and coordinator.
7474

75-
* The coordinator determines the fix approach and who will provide a patch.
76-
Some reporters are willing to provide or collaborate to create a patch,
75+
* The coordinator determines the fix approach and who will provide a fix.
76+
Some reporters are willing to provide or collaborate to create a fix,
7777
otherwise relevant core developers can be invited to collaborate by
7878
the coordinator.
7979

8080
* For **Low** and **Medium** severity vulnerabilities it is acceptable
81-
to develop a patch in public.
81+
to develop a fix in public.
8282
The pull request must be marked with the ``security`` and ``release-blocker``
83-
labels so that a release is not created without including the patch.
83+
labels so that a release is not created without including the fix.
8484

85-
* For **High** and **Critical** severity vulnerabilities the patch must be
85+
* For **High** and **Critical** severity vulnerabilities the fix must be
8686
developed privately using GitHub Security Advisories' "Private Forks" feature.
8787
Core developers can be added to the GitHub Security Advisory via "collaborators"
88-
to work on the fix together. Once a patch is approved privately and tested,
88+
to work on the fix together. Once a fix is approved privately and tested,
8989
a public issue and pull request can be created with
9090
the ``security`` and ``release-blocker`` labels.
9191

developer-workflow/stdlib.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You have a several options for this:
3636

3737
If you have found general acceptance and usefulness for your code from people,
3838
you can open an issue on the `issue tracker`_ with the code attached as a
39-
:ref:`pull request <patch>`. If possible, also submit a
39+
:ref:`pull request <pullrequest>`. If possible, also submit a
4040
:ref:`contributor agreement <contributor_agreement>`.
4141

4242
If a core developer decides that your code would be useful to the general
@@ -91,7 +91,7 @@ In order for a module to even be considered for inclusion into the stdlib, a
9191
couple of requirements must be met.
9292

9393
The most basic is that the code must meet
94-
:ref:`standard patch requirements <patch>`. For code that has
94+
:ref:`standard pull request requirements <pullrequest>`. For code that has
9595
been developed outside the stdlib typically this means making sure the coding
9696
style guides are followed and that the proper tests have been written.
9797

@@ -112,7 +112,7 @@ infrastructure (that is, the module is no longer directly maintained outside of
112112
Python). This prevents a divergence between the code that is included in the
113113
stdlib and that which is released outside the stdlib (typically done to provide
114114
the module to older versions of Python). It also removes the burden of forcing
115-
core developers to have to redirect bug reports or patches to an external issue
115+
core developers to have to redirect bug reports or changes to an external issue
116116
tracker and :abbr:`VCS (version control system)`.
117117

118118
Someone involved with the development of the

getting-started/fixing-issues.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Fixing "easy" issues (and beyond)
66
=================================
77

88
When you feel comfortable enough to want to help tackle issues by trying to
9-
create a patch to fix an issue, you can start by looking at the `"easy"
9+
create a pull request to fix an issue, you can start by looking at the `"easy"
1010
issues`_. These issues *should* be ones where it should take no longer than a
1111
day or weekend to fix. But because the "easy" classification is typically done
1212
at triage time it can turn out to be inaccurate, so do feel free to leave a
@@ -17,8 +17,8 @@ are not considered easy and try to fix those. It must be warned, though, that
1717
it is quite possible that a bug that has been left open has been left into that
1818
state because of the difficulty compared to the benefit of the fix. It could
1919
also still be open because no consensus has been reached on how to fix the
20-
issue (although having a patch that proposes a fix can turn the tides of the
21-
discussion to help bring it to a close). Regardless of why the issue is open,
20+
issue, although having a pull request that proposes a fix can turn the tides of the
21+
discussion to help bring it to a close. Regardless of why the issue is open,
2222
you can also always provide useful comments if you do attempt a fix, successful
2323
or not.
2424

getting-started/git-boot-camp.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Enabling ``autocrlf`` on Windows
132132

133133
The ``autocrlf`` option will fix automatically any Windows-specific line endings.
134134
This should be enabled on Windows, since the public repository has a hook which
135-
will reject all changesets having the wrong line endings::
135+
will reject all commits having the wrong line endings::
136136

137137
$ git config --global core.autocrlf input
138138

@@ -356,7 +356,7 @@ Scenario:
356356
the upstream CPython repository.
357357

358358
Please do not try to solve this by creating a pull request from
359-
``python:main`` to ``<username>:main`` as the authors of the patches will
359+
``python:main`` to ``<username>:main`` as the authors of the pull requests will
360360
get notified unnecessarily.
361361

362362
Solution::
@@ -435,8 +435,8 @@ Solution:
435435

436436
.. _git_pr:
437437

438-
Downloading other's patches
439-
---------------------------
438+
Checking out others' pull requests
439+
----------------------------------
440440

441441
Scenario:
442442

getting-started/pull-request-lifecycle.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,8 @@ should do to help ensure that your pull request is accepted.
243243
``patchcheck``
244244
==============
245245

246-
``patchcheck`` is a simple automated patch checklist that guides a developer
247-
through the common patch generation checks. To run ``patchcheck``:
246+
``patchcheck`` is a simple automated checklist for changes in progress that
247+
guides a developer through common checks. To run ``patchcheck``:
248248

249249
On *Unix* (including macOS)::
250250

@@ -256,7 +256,7 @@ On *Windows* (after any successful build):
256256
257257
.\python.bat Tools\patchcheck\patchcheck.py
258258
259-
The automated patch checklist runs through:
259+
The automated checklist runs through:
260260

261261
* Are there any whitespace problems in Python files?
262262
(using :cpy-file:`Tools/patchcheck/reindent.py`)
@@ -271,10 +271,10 @@ The automated patch checklist runs through:
271271
* Has ``configure`` been regenerated, if necessary?
272272
* Has ``pyconfig.h.in`` been regenerated, if necessary?
273273

274-
The automated patch check doesn't actually *answer* all of these
274+
The automated checks don't actually *answer* all of these
275275
questions. Aside from the whitespace checks, the tool is
276276
a memory aid for the various elements that can go into
277-
making a complete patch.
277+
making a complete pull request.
278278

279279

280280
.. _good-commits:

getting-started/setup-building.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ changes to Python code will be picked up by the interpreter for immediate
127127
use and testing. (If you change C code, you will need to recompile the
128128
affected files as described below.)
129129

130-
Patches for the documentation can be made from the same repository; see
130+
Changes for the documentation can be made from the same repository; see
131131
:ref:`documenting`.
132132

133133
.. _install-pre-commit:
@@ -1033,7 +1033,7 @@ you'd prefer to use that directly.
10331033
Create a CPython codespace
10341034
--------------------------
10351035

1036-
Here are the basic steps needed to contribute a patch using Codespaces.
1036+
Here are the basic steps needed to contribute a pull request using Codespaces.
10371037
You first need to navigate to the
10381038
`CPython repo <https://github.com/python/cpython>`_ hosted on GitHub.
10391039

index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ community that maintains Python. We welcome your contributions to Python!
2222
Quick reference
2323
---------------
2424

25-
Here are the basic steps needed to get set up and contribute a patch.
25+
Here are the basic steps needed to get set up and contribute a pull request.
2626
This is meant as a checklist, once you know the basics. For complete
2727
instructions please see the :ref:`setup guide <setup>`.
2828

testing/buildbots.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ will schedule a new build to be run as soon as possible.
1616

1717
The build steps run by the buildbots are the following:
1818

19-
* Check out the source tree for the changeset which triggered the build
19+
* Check out the source tree for the change which triggered the build
2020
* Compile Python
2121
* Run the test suite using :ref:`strenuous settings <strenuous_testing>`
2222
* Clean up the build tree
@@ -56,7 +56,7 @@ There are three ways of visualizing recent build results:
5656
* The Web interface for each branch at https://www.python.org/dev/buildbot/,
5757
where the so-called "waterfall" view presents a vertical rundown of recent
5858
builds for each builder. When interested in one build, you'll have to
59-
click on it to know which changesets it corresponds to. Note that
59+
click on it to know which commits it corresponds to. Note that
6060
the buildbot web pages are often slow to load, be patient.
6161

6262
* The command-line ``bbreport.py`` client, which you can get from
@@ -78,16 +78,16 @@ There are three ways of visualizing recent build results:
7878
If you like IRC, having an IRC client open to the #python-dev-notifs channel on
7979
irc.libera.chat is useful. Any time a builder changes state (last build
8080
passed and this one didn't, or vice versa), a message is posted to the channel.
81-
Keeping an eye on the channel after pushing a changeset is a simple way to get
81+
Keeping an eye on the channel after pushing a commits is a simple way to get
8282
notified that there is something you should look in to.
8383

8484
Some buildbots are much faster than others. Over time, you will learn which
8585
ones produce the quickest results after a build, and which ones take the
8686
longest time.
8787

88-
Also, when several changesets are pushed in a quick succession in the same
88+
Also, when several commits are pushed in a quick succession in the same
8989
branch, it often happens that a single build is scheduled for all these
90-
changesets.
90+
commits.
9191

9292
Stability
9393
=========

triage/triaging.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ you can help by making sure the pull request:
9292
* includes proper tests
9393
* includes proper documentation changes
9494
* includes a :ref:`NEWS entry <news-entry>` (if needed)
95-
* includes the author in ``Misc/ACKS``, either already or the patch adds them
95+
* includes the author in ``Misc/ACKS``, either already or the pull request adds them
9696
* doesn't have conflicts with the ``main`` branch
9797
* :ref:`doesn't have failing CI checks <keeping-ci-green>`
9898

0 commit comments

Comments
 (0)