@@ -154,12 +154,27 @@ Before merging a PR you must have the required approvals. See
154
154
Landing your change
155
155
-------------------
156
156
157
- When your PR has been approved you can merge your changes.
157
+ After your PR is approved, ensure that:
158
158
159
- If you do not have write permissions for the repository, the merge button in
160
- GitHub's web interface will be disabled. If this is the case, continue following
161
- the steps here but ask one of your reviewers to click the merge button on your
162
- behalf.
159
+ * The PR title and description describe the final changes. These will be used
160
+ as the title and message of the final squashed commit. The titles and
161
+ messages of commits in the PR will **not ** be used.
162
+ * You have set a valid email address in your GitHub account, see :ref: `github-email-address `.
163
+
164
+ .. note ::
165
+ The LLVM Project monorepo on GitHub is configured to always use "Squash
166
+ and Merge" as the pull request merge option when using the web interface.
167
+ With this option, GitHub uses the PR summary as the default commit
168
+ message.
169
+
170
+ Users with write access who can merge PRs have a final opportunity to edit
171
+ the commit title and message before merging. However, this option is not
172
+ available to contributors without write access.
173
+
174
+ At this point, you can merge your changes. If you do not have write permissions
175
+ for the repository, the merge button in GitHub's web interface will be
176
+ disabled. If this is the case, continue following the steps here but ask one of
177
+ your reviewers to click the merge button on your behalf.
163
178
164
179
If the PR is a single commit, all you need to do is click the merge button in
165
180
GitHub's web interface.
@@ -221,21 +236,6 @@ commonly used first:
221
236
request will understand that you're rebasing just your patches, and display
222
237
this result correctly with a note that a force push did occur.
223
238
224
- .. note ::
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.
233
-
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.
238
-
239
239
Pre-merge Continuous Integration (CI)
240
240
-------------------------------------
241
241
@@ -459,8 +459,8 @@ Releases
459
459
Backporting Fixes to the Release Branches
460
460
-----------------------------------------
461
461
You can use special comments on issues or pull requests to make backport
462
- requests for the release branches. To do this, after your pull request has
463
- been merged:
462
+ requests for the release branches. To do this, after your pull request has been
463
+ merged:
464
464
465
465
1. Edit "Milestone" at the right side of the isssue or pull request
466
466
to say "LLVM X.Y Release"
0 commit comments