@@ -15,6 +15,12 @@ The LLVM Project uses `GitHub <https://github.com/>`_ for
1515This page describes how the LLVM Project users and developers can
1616participate 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+
1824Branches
1925========
2026
@@ -144,6 +150,7 @@ Approvals
144150Before 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 :
147154Landing 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
225239Pre-merge Continuous Integration (CI)
226240-------------------------------------
@@ -445,8 +459,8 @@ Releases
445459Backporting Fixes to the Release Branches
446460-----------------------------------------
447461You 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
4514651. Edit "Milestone" at the right side of the isssue or pull request
452466 to say "LLVM X.Y Release"
0 commit comments