[PATCH] D69353: Clean up the language for contributing

[Jeremy Bennett via Phabricator via llvm-commits]

jeremybennett created this revision.
jeremybennett added reviewers: chandlerc, meikeb.
Herald added a project: LLVM.

This commit clarifies some of the language on how to submit a
	patch to make it more inclusive.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D69353

Files:
  llvm/docs/Contributing.rst


Index: llvm/docs/Contributing.rst
===================================================================
--- llvm/docs/Contributing.rst
+++ llvm/docs/Contributing.rst
@@ -61,26 +61,32 @@
 to request a review using Phabricator.
 
 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
-code owner (see CODE_OWNERS.txt) and other people doing work in the area your
-patch touches. If you are using Phabricator, add them to the `Reviewers` field
-when creating a review and if you are using `llvm-commits`, add them to the CC of
-your email.
+and add them to your patch when requesting a review. Suitable reviewers
+include the code owner for the area your patch affects.  There is a file named
+``CODE_OWNERS.txt`` or ``CODE_OWNERS.TXT`` in the subdirectory for each
+project of the main ``llvm-project`` repository which lists the code owners
+for that project.  Other appropriate reviewers include people doing work in
+the area your patch touches - they will be posting discussions of their work
+on the mailing list.  If you are using Phabricator, add them to the `Reviewers`
+field when creating a review and if you are using `llvm-commits`, add them to
+the CC of your email.
 
 A reviewer may request changes or ask questions during the review. If you are
-uncertain on how to provide test cases, documentation, etc., feel free to ask
-for guidance during the review. Please address the feedback and re-post an
-updated version of your patch. This cycle continues until all requests and comments
-have been addressed and a reviewer accepts the patch with a `Looks good to me` or `LGTM`.
-Once that is done the change can be committed. If you do not have commit
-access, please let people know during the review and someone should commit it
-on your behalf.
+uncertain on how to provide test cases, documentation, etc., ask for guidance
+during the review. You can then address the feedback and re-post an updated
+version of your patch. This cycle continues until all requests and comments
+have been addressed and a reviewer accepts the patch with a `Looks good to me`
+or `LGTM`.  This can take a while - on average a review takes 3 or 4
+cycles.  Once that is done the change can be committed. If you do not have
+commit access, please let people know during the review and someone should
+commit it on your behalf.
 
 If you have received no comments on your patch for a week, you can request a
-review by 'ping'ing a patch by responding to the email thread containing the
-patch, or the Phabricator review with "Ping." The common courtesy 'ping' rate
-is once a week. Please remember that you are asking for valuable time from other
-professional developers.
+review by responding to the email thread containing the patch, or the
+Phabricator review with a single line message "Ping."  The common courtesy
+'ping' rate is once a week.  Sometimes reviewers can be busy, and if you are
+finding difficulty with getting a patch reviewed after a couple of weeks, ask
+the code owner to help find alternative reviewers.
 
 
 Helpful Information About LLVM


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D69353.226169.patch
Type: text/x-patch
Size: 3164 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20191023/a3bdec91/attachment.bin>