diff --git a/llvm/docs/Contributing.rst b/llvm/docs/Contributing.rst index 1200ee987e9d9..9311f39b6e697 100644 --- a/llvm/docs/Contributing.rst +++ b/llvm/docs/Contributing.rst @@ -107,11 +107,20 @@ way, in which case you can still get the attention of potential reviewers by CC' them in a comment -- just @name them. If you have received no comments on your patch for a week, you can request a -review by 'ping'ing the GitHub PR with "Ping". The common courtesy 'ping' rate +review by 'ping'ing the GitHub PR with "Ping" in a comment. The common courtesy 'ping' rate is once a week. Please remember that you are asking for valuable time from -other professional developers. Finally, if you do not have commit access, -please let people know during the review and someone should commit it on your -behalf once it has been accepted. +other professional developers. + +After your PR is approved, ensure that: + + * The PR title and description describe the final changes. These will be used + as the title and message of the final squashed commit. The titles and + messages of commits in the PR will **not** be used. + * You have set a valid email address in your GitHub account, see :ref:`github-email-address`. + +Now you can merge your PR. If you do not have the ability to merge the PR, ask your +reviewers to merge it on your behalf. You must do this explicitly, as reviewers' +default assumption is that you are able to merge your own PR. For more information on LLVM's code-review process, please see :doc:`CodeReview`. diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst index 5b1f7dc29bee3..b125fcb0da7ab 100644 --- a/llvm/docs/DeveloperPolicy.rst +++ b/llvm/docs/DeveloperPolicy.rst @@ -105,10 +105,17 @@ When submitting patches, please do not add confidentiality or non-disclosure notices to the patches themselves. These notices conflict with the LLVM licensing terms and may result in your contribution being excluded. +.. _github-email-address: + +Email Addresses +--------------- + The LLVM project uses email to communicate to contributors outside of the GitHub platform about their past contributions. Primarily, our buildbot infrastructure uses emails to contact contributors about build and test -failures. Therefore, the LLVM community requires contributors to have a public +failures. + +Therefore, the LLVM community requires contributors to have a public email address associated with their GitHub commits, so please ensure that "Keep my email addresses private" is disabled in your `account settings `_.