[Django] #35894: Rename "patch" to "pull request" in the contributor documentation

24 views
Skip to first unread message

Django

unread,
Nov 6, 2024, 3:10:44 PM11/6/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste | Owner: Baptiste Mispelon
Mispelon |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 5.0
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
No one effectively contributes via patches anymore (according to the Trac
database, only ~10 patches were submitted in the past 12 months), I think
it's time we update Trac and our documentation to reflect that.

I've created a PR to change the wording on Trac itself:
https://github.com/django/code.djangoproject.com/pull/224

What's left now is to update our contributing guides in the documentation.
--
Ticket URL: <https://code.djangoproject.com/ticket/35894>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Nov 6, 2024, 4:30:52 PM11/6/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Baptiste
Type: | Mispelon
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Baptiste Mispelon):

* Attachment "issue35894.diff" added.

Django

unread,
Nov 6, 2024, 4:32:17 PM11/6/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Baptiste
Type: | Mispelon
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Baptiste Mispelon):

* has_patch: 0 => 1

Comment:

I've attached a patch for the documentation changes 🙃

(If you insist, I've also opened a PR:
https://github.com/django/django/pull/18780)
--
Ticket URL: <https://code.djangoproject.com/ticket/35894#comment:1>

Django

unread,
Nov 6, 2024, 4:54:17 PM11/6/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Baptiste
Type: | Mispelon
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Baptiste Mispelon):

I also considered replacing the expression "ready for checkin" with "ready
for merging" (which has the huge advantage of having the exact same number
of letters), but that would require a database migration on Trac which
could be a bit annoying (though not impossible).

If you think that's worth it I can look into that as well.
--
Ticket URL: <https://code.djangoproject.com/ticket/35894#comment:2>

Django

unread,
Nov 6, 2024, 7:26:35 PM11/6/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Baptiste
Type: | Mispelon
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Tim Graham):

There were some recent changes along these lines in
55a2e3136b13d1af95a4129001dac963c26d8415.

I'd prefer not to rename files and cause external broken links
([https://www.w3.org/Provider/Style/URI Cool URIs Don't Change]). (E.g.
you proposed to rename ....writing-code/submitting-patches.txt to
.../writing-code/pull-requests.txt.)

You also proposed to remove the ".. _patch-review-checklist:" heading
which I have used extensively in Trac comments as well as on the
PatchReviewChecklist wiki page (but if the page is renamed the link will
break anyway).

It's possible Django will use Git, GitHub, and "pull requests" forever,
but it might be worth considering if these specific terms should really be
embedded in URLs.
--
Ticket URL: <https://code.djangoproject.com/ticket/35894#comment:3>

Django

unread,
Nov 7, 2024, 2:07:47 AM11/7/24
to django-...@googlegroups.com
#35894: Rename "patch" to "pull request" in the contributor documentation
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Baptiste
Type: | Mispelon
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Claude Paroz):

I also think that "pull request" is a GitHubism. Not that we should not
use it, but having "patch" here and there as a more generic term doesn't
shock me.
--
Ticket URL: <https://code.djangoproject.com/ticket/35894#comment:4>
Reply all
Reply to author
Forward
0 new messages