Skip to content

Default message for merge commits documented (partially) incorrectly #38163

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

Open
1 task done
keikoro opened this issue May 10, 2025 · 1 comment
Open
1 task done

Default message for merge commits documented (partially) incorrectly #38163

keikoro opened this issue May 10, 2025 · 1 comment
Labels
content This issue or pull request belongs to the Docs Content team pull requests Content related to pull requests

Comments

@keikoro
Copy link

keikoro commented May 10, 2025

Code of Conduct

What article on docs.github.com is affected?

Repositories/Branches and merges/Configure PR merges/Configure commit merging

What part(s) of the article would you like to see updated?

The docs state:

The default message includes the pull request number and title. For example, Merge pull request #123 from patch-1. You can also choose to use just the pull request title, or the pull request title and description.

This doesn't seem to be true for merge commits created in organisation repos.

What I'm seeing in an org I belong to is the format:
Merge pull request #123 from ORGNAME/patch-1

Since there is no way to preview the default message from within a repo's settings, I couldn't tell if this odd formatting choice was due to an org-wide customisation/override created by an admin (potentially in error) or if this was the site-wide default. See also this community comment I left on an existing discussion re: default commit messages in Feb, expressing my confusion.

Well. I just thought to run a search for "merge pull request" on the github org. Looks like it's actually GitHub which drops the repo name from the ref in its global default?

I personally find this rather unfortunate because it's virtually indistinguishable from slash-separated refs. It also obfuscates the origins of a project – if I wanted to trace an old clone whose upstream is no longer available (and whose local name I couldn't necessarily rely on), I'd hope to find the actual project name in there somewhere, more so than the name of the publisher. If the intention is to "bake" the organization name into merge commits, the full ref hierarchy should be included rather than a version which omits the project name, i.e. ORGNAME/REPONAME/patch-1, for increased transparency.

Be that as it may, the docs should be updated to reflect the actual format(s) of the default message(s).

Additional information

No response

@keikoro keikoro added the content This issue or pull request belongs to the Docs Content team label May 10, 2025
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 10, 2025
@Sharra-writes Sharra-writes added pull requests Content related to pull requests and removed triage Do not begin working on this issue until triaged by the team labels May 12, 2025
@Sharra-writes
Copy link
Contributor

Thanks for opening this issue! I'll get it triaged for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team pull requests Content related to pull requests
Projects
None yet
Development

No branches or pull requests

4 participants
@keikoro @Sharra-writes and others