Skip to content

Commit 07be409

Browse files
committed
fixup! [llvm][docs][nfc] Add a note on GitHub's "squash and merge"
Expand as per David's suggestions
1 parent 3c234d7 commit 07be409

File tree

2 files changed

+29
-17
lines changed

2 files changed

+29
-17
lines changed

llvm/docs/Contributing.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,16 +129,10 @@ review by 'ping'ing the GitHub PR with "Ping" in a comment. The common courtesy
129129
is once a week. Please remember that you are asking for valuable time from
130130
other professional developers.
131131

132-
After your PR is approved, ensure that:
133-
134-
* The PR title and description describe the final changes. These will be used
135-
as the title and message of the final squashed commit. The titles and
136-
messages of commits in the PR will **not** be used.
137-
* You have set a valid email address in your GitHub account, see :ref:`github-email-address`.
138-
139-
Now you can merge your PR. If you do not have the ability to merge the PR, ask your
140-
reviewers to merge it on your behalf. You must do this explicitly, as reviewers'
141-
default assumption is that you are able to merge your own PR.
132+
After your PR is approved, you can merge it. If you do not have the ability to
133+
merge the PR, ask your reviewers to merge it on your behalf. You must do this
134+
explicitly, as reviewers' default assumption is that you are able to merge your
135+
own PR.
142136

143137
For more information on LLVM's code-review process, please see
144138
:doc:`CodeReview`.
@@ -148,6 +142,10 @@ For more information on LLVM's code-review process, please see
148142
For developers to commit changes from Git
149143
-----------------------------------------
150144

145+
.. note::
146+
See also :doc:`landing-your-change` for more details on merging your changes
147+
into LLVM project monorepo.
148+
151149
Once a patch is reviewed, you can select the "Squash and merge" button in the
152150
GitHub web interface.
153151

llvm/docs/GitHub.rst

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ The LLVM Project uses `GitHub <https://github.com/>`_ for
1515
This page describes how the LLVM Project users and developers can
1616
participate in the project using GitHub.
1717

18+
Before your first PR
19+
====================
20+
21+
Please ensure that you have set a valid email address in your GitHub account,
22+
see :ref:`github-email-address`.
23+
1824
Branches
1925
========
2026

@@ -144,6 +150,7 @@ Approvals
144150
Before merging a PR you must have the required approvals. See
145151
:ref:`lgtm_how_a_patch_is_accepted` for more details.
146152

153+
.. _landing-your-change:
147154
Landing your change
148155
-------------------
149156

@@ -215,12 +222,19 @@ commonly used first:
215222
this result correctly with a note that a force push did occur.
216223

217224
.. 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.
225+
The LLVM Project monorepo on GitHub is configured to always use "Squash
226+
and Merge" as the pull request merge option when using the web interface.
227+
With this option, GitHub uses the PR summary as the default commit
228+
message.
229+
230+
Users with commit access who can merge PRs have a final opportunity to edit
231+
the commit title and message before merging. However, this option is not
232+
available to contributors without write access.
221233

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.
234+
In practice, PR summaries often become commit messages. Ensure that the PR
235+
title and description are up to date, free of typos, and clearly written —
236+
especially if you do not have write permissions and require someone else to
237+
merge your PR.
224238

225239
Pre-merge Continuous Integration (CI)
226240
-------------------------------------
@@ -445,8 +459,8 @@ Releases
445459
Backporting Fixes to the Release Branches
446460
-----------------------------------------
447461
You can use special comments on issues or pull requests to make backport
448-
requests for the release branches. To do this, after your pull request has been
449-
merged:
462+
requests for the release branches. To do this, after your pull request has
463+
been merged:
450464

451465
1. Edit "Milestone" at the right side of the isssue or pull request
452466
to say "LLVM X.Y Release"

0 commit comments

Comments
 (0)