Skip to content

[llvm][Docs] Clarify the process for requesting a merge on your behalf #124154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 24, 2025
Merged

[llvm][Docs] Clarify the process for requesting a merge on your behalf #124154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ac58df
[llvm][Docs] Clarify the process for requesting a merge on your behalf
DavidSpickett Jan 23, 2025
c9d50d1
emphasise need to ask for merge
DavidSpickett Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions llvm/docs/Contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
9 changes: 8 additions & 1 deletion llvm/docs/DeveloperPolicy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/settings/emails>`_.
Expand Down
Loading