#35894: Move away from the term "patch" to refer to a contribution/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: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Natalia Bidart):
Thank you, Baptiste, for initiating this discussion!
I’m on the side of avoiding the term "pull request" (except when referring
to GitHub-concrete docs, specifically the
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/working-with-git/ Working with Git and GitHub docs]). As Tim mentioned,
Andreu and I worked to replace several instances of "patch" in the docs
[https://github.com/django/django/commit/55a2e3136b13d1af95a4129001dac963c26d8415
in this patch] :clown:
In that revision, my priority was to avoid breaking existing anchors and
to ensure that "pull request" was not used as a direct synonym for
"patch," since they have distinct meanings. I’ll be adding comments on
each PR, but if we are moving away from "patch," I think it’s important to
use platform-neutral terms, unless we're specifically referring to a
GitHub pull request.
I also believe "patch" is not exclusive to SVN. I’ve used it for a long
time to describe a diff file containing code changes, even before tools
like CVS came along. GitHub itself uses the term as well, you can
download the patch for any PR by appending `.patch` to the PR URL:
https://github.com/django/djangoproject.com/pull/18780.patch
Additionally, I don’t see "pull request" as a generic term. It seems
specific to GitHub, especially since other platforms like GitLab use
[https://docs.gitlab.com/ee/user/project/merge_requests/ "Merge Request"]
and Launchpad uses [https://dev.launchpad.net/UsingMergeProposals "Merge
Proposal"]. For that reason, I’d prefer not to replace "patch" with "pull
request." In fact, "patch" is one of the more platform-agnostic terms we
have, though I agree that we should use it carefully and in its original
sense (i.e., a diff of code proposing a change).
--
Ticket URL: <https://code.djangoproject.com/ticket/35894#comment:12>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/010701934042b479-d8d8cfb5-28dd-4991-bc6e-d94e2901f79b-000000%40eu-central-1.amazonses.com.
