Skip to content

Commit 4b6fc49

Browse files
[llvm][Docs] Clarify the process for requesting a merge on your behalf (#124154)
This makes it more clear what you the author must do, and what reviewers can expect you to do, before an approved PR can be merged. Spliting out the email bit into a section also means we can link directly to it in discussions. This relies on one of those parties actually reading this, but I plan to tackle the case where they don't with some new automation.
1 parent 1c0af8d commit 4b6fc49

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

llvm/docs/Contributing.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,20 @@ way, in which case you can still get the attention of potential reviewers by CC'
107107
them in a comment -- just @name them.
108108

109109
If you have received no comments on your patch for a week, you can request a
110-
review by 'ping'ing the GitHub PR with "Ping". The common courtesy 'ping' rate
110+
review by 'ping'ing the GitHub PR with "Ping" in a comment. The common courtesy 'ping' rate
111111
is once a week. Please remember that you are asking for valuable time from
112-
other professional developers. Finally, if you do not have commit access,
113-
please let people know during the review and someone should commit it on your
114-
behalf once it has been accepted.
112+
other professional developers.
113+
114+
After your PR is approved, ensure that:
115+
116+
* The PR title and description describe the final changes. These will be used
117+
as the title and message of the final squashed commit. The titles and
118+
messages of commits in the PR will **not** be used.
119+
* You have set a valid email address in your GitHub account, see :ref:`github-email-address`.
120+
121+
Now you can merge your PR. If you do not have the ability to merge the PR, ask your
122+
reviewers to merge it on your behalf. You must do this explicitly, as reviewers'
123+
default assumption is that you are able to merge your own PR.
115124

116125
For more information on LLVM's code-review process, please see
117126
:doc:`CodeReview`.

llvm/docs/DeveloperPolicy.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,17 @@ When submitting patches, please do not add confidentiality or non-disclosure
105105
notices to the patches themselves. These notices conflict with the LLVM
106106
licensing terms and may result in your contribution being excluded.
107107

108+
.. _github-email-address:
109+
110+
Email Addresses
111+
---------------
112+
108113
The LLVM project uses email to communicate to contributors outside of the
109114
GitHub platform about their past contributions. Primarily, our buildbot
110115
infrastructure uses emails to contact contributors about build and test
111-
failures. Therefore, the LLVM community requires contributors to have a public
116+
failures.
117+
118+
Therefore, the LLVM community requires contributors to have a public
112119
email address associated with their GitHub commits, so please ensure that "Keep
113120
my email addresses private" is disabled in your
114121
`account settings <https://github.com/settings/emails>`_.

0 commit comments

Comments
 (0)