Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Smoother terminology: commit, pull request, patch, changeset #1443

Closed
nedbat opened this issue Oct 14, 2024 · 2 comments
Closed

Smoother terminology: commit, pull request, patch, changeset #1443

nedbat opened this issue Oct 14, 2024 · 2 comments
Labels

Comments

@nedbat
Copy link
Member

nedbat commented Oct 14, 2024

Describe the bug

These four terms are used in the devguide. We should make the terminology uniform, and based on git/GitHub usage.

  • I think we should do away with "changeset" completely.
  • "Patch" can often be changed to "commit" or "pull request" or even just "change." We have a habit of saying "patch" in the change log: "Patch by Josephine Koder," I'm not sure what to do about that. A few places use the term in the git sense, a diff applied textually, which I think is OK.
@nedbat nedbat added the bug label Oct 14, 2024
@nedbat nedbat changed the title commit/pull request/patch/changeset Smooth out terminology: commit, pull request, patch, changeset Oct 14, 2024
@nedbat nedbat changed the title Smooth out terminology: commit, pull request, patch, changeset Smoother: commit, pull request, patch, changeset Oct 14, 2024
@nedbat nedbat changed the title Smoother: commit, pull request, patch, changeset Smoother terminology: commit, pull request, patch, changeset Oct 14, 2024
@ezio-melotti
Copy link
Member

"changset" was the official term used in the Mercurial days, and it should be fine to get rid of those since Git uses the term "commit" instead.
In some contexts, "patch" was used to refer to the actual .diff files that we used to attach to the b.p.o issues before we moved to GitHub and started using PRs, and in those instances it can be replaced with the terms you suggested. The change log initially used the term to refer to the .diff files, but since "patch" is also a more generic concept1, it still works.

Footnotes

  1. e.g. in a sentence like "The vulnerability was patched by merging Josephine Koder's PR."

@nedbat
Copy link
Member Author

nedbat commented Oct 16, 2024

PR: #1446

nedbat added a commit that referenced this issue Oct 17, 2024

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
@nedbat nedbat closed this as completed Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants