Skip to content

Commit 3c234d7

Browse files
committed
[llvm][docs][nfc] Add a note on GitHub's "squash and merge"
From what I can tell, many people are still unaware that in LLVM we use the PR summary (rather than PR commit messages) as the message for the final commit to be merged. This is particularly unclear to folks without commit access (folks with commit access can edit the commit message just before merging).
1 parent cd3acd1 commit 3c234d7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

llvm/docs/GitHub.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,13 @@ commonly used first:
214214
request will understand that you're rebasing just your patches, and display
215215
this result correctly with a note that a force push did occur.
216216

217+
.. note::
218+
When using `Squash and merge` in LLVM’s GitHub web interface, GitHub will
219+
use the pull request title and description as the commit message. Only
220+
users with commit access can edit the commit message just before merging a PR.
221+
222+
If you do not have write permissions, make sure the PR title and description
223+
are **up to date** before the review process concludes.
217224

218225
Pre-merge Continuous Integration (CI)
219226
-------------------------------------

0 commit comments

Comments
 (0)