[llvm] 1f0964f - [llvm][Docs] Clarify finding maintainers

David Spickett via llvm-commits llvm-commits at lists.llvm.org
Thu Jan 23 06:53:22 PST 2025


Author: David Spickett
Date: 2025-01-23T14:51:18Z
New Revision: 1f0964f81e5ae90e1c50fcdd103ec9c838b995e0

URL: https://github.com/llvm/llvm-project/commit/1f0964f81e5ae90e1c50fcdd103ec9c838b995e0
DIFF: https://github.com/llvm/llvm-project/commit/1f0964f81e5ae90e1c50fcdd103ec9c838b995e0.diff

LOG: [llvm][Docs] Clarify finding maintainers

By noting where the files are to be found, and adding some
whitespace to break up large blocks.

(the merge on behalf bit needs a refresh but this will go
into review later after this)

Added: 
    

Modified: 
    llvm/docs/Contributing.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/Contributing.rst b/llvm/docs/Contributing.rst
index cf48c66dc0d068..1200ee987e9d94 100644
--- a/llvm/docs/Contributing.rst
+++ b/llvm/docs/Contributing.rst
@@ -94,13 +94,17 @@ For more information about the workflow of using GitHub Pull Requests see our
 `LLVM's Phabricator <https://reviews.llvm.org>`_ instance.
 
 To make sure the right people see your patch, please select suitable reviewers
-and add them to your patch when requesting a review. Suitable reviewers are the
-maintainers (see ``Maintainers.rst``) and other people doing work in the area your
-patch touches. Github will normally suggest some reviewers based on rules or
-people that have worked on the code before. If you are a new contributor, you
-will not be able to select reviewers in such a way, in which case you can still
-get the attention of potential reviewers by CC'ing them in a comment -- just
- at name them.
+and add them to your patch when requesting a review.
+
+Suitable reviewers are the maintainers of the project you are modifying, and
+anyone else working in the area your patch touches. To find maintainers, look for
+the ``Maintainers.md`` or ``Maintainers.rst`` file in the root of the project's
+sub-directory. For example, LLVM's is ``llvm/Maintainers.md`` and Clang's is
+``clang/Maintainers.rst``.
+
+If you are a new contributor, you will not be able to select reviewers in such a
+way, in which case you can still get the attention of potential reviewers by CC'ing
+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


        


More information about the llvm-commits mailing list