summaryrefslogtreecommitdiff
path: root/docs/code_reviews.md
diff options
context:
space:
mode:
authorJett Rink <jettrink@chromium.org>2019-10-02 11:24:02 -0600
committerCommit Bot <commit-bot@chromium.org>2019-12-19 14:20:50 +0000
commitc8c2fc0f0790ad8266855f9224aefcc2a447defb (patch)
treef53aadc26bc5c2eeabae3b83b3b06429d3a9b5a0 /docs/code_reviews.md
parent62a4510bf29ccec8980ab965d154e6e29233ef93 (diff)
downloadchrome-ec-c8c2fc0f0790ad8266855f9224aefcc2a447defb.tar.gz
doc: add doc for code review rotation
We will use cros-ec-reviewers@google.com account to trigger the round-robin code reviewer assignment for CLs. If you are the R line of this CL, then you are on the initial list :) BRANCH=none BUG=b:142125160 TEST=builds Change-Id: I121a8acc984b6b99bb9c1f3638ef431822080f0a Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1972607 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org> Reviewed-by: Keith Short <keithshort@chromium.org> Reviewed-by: Scott Collyer <scollyer@chromium.org> Reviewed-by: Eric Yilun Lin <yllin@chromium.org> Reviewed-by: Diana Z <dzigterman@chromium.org>
Diffstat (limited to 'docs/code_reviews.md')
-rw-r--r--docs/code_reviews.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/code_reviews.md b/docs/code_reviews.md
new file mode 100644
index 0000000000..df99a231a7
--- /dev/null
+++ b/docs/code_reviews.md
@@ -0,0 +1,33 @@
+# Code Reviews
+
+The platform/ec repository makes use of a code review system that tries to
+evenly distributed code reviews among available reviewers.
+
+## How to request a review
+
+Add `cros-ec-reviewers@google.com` to the reviewer line in Gerrit. A background
+job will come around and replace the `cros-ec-reviewers@google.com` address with
+the next available reviewer in the EC reviewer rotation. This typically takes on
+the order of minutes.
+
+Optionally, you can click the [FIND OWNERS] button in the UI, and select
+`cros-ec-reviewers@google.com`
+
+## When to use review system
+
+If you are modifying code in `common/`, `chip/`, or `core/`, feel free to use
+the `cros-ec-reviewers@google.com` system. It is **never** a requirement to use
+`cros-ec-reviewers@google.com`. You can always request a review from a specific
+person.
+
+## Responsibilities of reviewers
+
+If the selected reviewer is unfamiliar with code in a CL, then that reviewer
+should at least ensure that EC style and paradigms are being followed. Once EC
+styles and paradigms are being followed, then the reviewer can give a +1 and add
+the appropriate domain expert for that section of code.
+
+## How can I join the rotation?
+
+The list of reviewer is at http://google3/chrome/crosinfra/gwsq/ec_reviewers;
+just add your name there.