summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAbe Levkoy <alevkoy@chromium.org>2020-04-09 18:59:31 -0600
committerCommit Bot <commit-bot@chromium.org>2020-04-27 19:10:45 +0000
commita35cb2eae7cbe244c6debd53906280e2ac4f88d7 (patch)
tree3701e541aa31edc0e3ea695de9221340e6f1203f /docs
parent7639883334b6b1586ac39823075ed17e30fccde3 (diff)
downloadchrome-ec-a35cb2eae7cbe244c6debd53906280e2ac4f88d7.tar.gz
docs: Remove firmware code review guidelines
They have moved to the top-level docs directory. BUG=none TEST=Viewed rendered Markdown BRANCH=none Cq-Depend: chromium:2145046 Change-Id: Ibd140549b4b008448589abcb83b6120dca4ef642 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2145080 Reviewed-by: Jett Rink <jettrink@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/code_reviews.md109
1 files changed, 7 insertions, 102 deletions
diff --git a/docs/code_reviews.md b/docs/code_reviews.md
index 45bbb36095..8bda5fe31a 100644
--- a/docs/code_reviews.md
+++ b/docs/code_reviews.md
@@ -33,117 +33,22 @@ Reviewers should try to give an initial response within 1 business day of
receiving a review request. Thereafter, they should try to respond to new
comments by the author within 1 business day.
+## Review guidelines
+
+Authors and reviewers should follow the Chrome OS firmware review
+[guidelines][2] while publishing and reviewing code.
+
## How can I join the rotation?
Add your name to the [list of reviewers][1].
-## Code review guidelines
-### Goals for guidelines
-
-* Minimize review latency.
-* Minimize duplication of effort among reviewers.
-
-### Guidelines for all code reviews
-
-* Keep each CL to one logical change.
- * Where there are several layers of dependencies, break the patch up into
- multiple CLs.
- * Avoid significant scope increases in subsequent patchsets; when reviewers
- ask for significant additions, consider adding them in a follow-up CL
- instead of uploading a new patchset.
- * Refactor in a separate CL from functional changes; this also applies to
- unrelated style and typo fixes.
- * See Google small CL [guidelines][5] for more tips.
- * If you are about to send out more than 400 lines of non-trivial changes, and
- you haven’t written a design doc, consider whether you need one and who
- should review it.
-* Prefer to discuss significant design issues in bugs or design docs, before
- code review.
- * Associate a bug with a code review (`BUG=...`) when context is relevant.
-* Indicate clearly when a CL is not yet ready for review and when it is; don’t
- start the review until you’ve stopped making changes.
- * Use `repo upload --no-emails` to avoid sending emails for CLs not ready for
- review.
- * Use Gerrit comments as needed to clarify that a CL is now ready for review.
- * Recommended: Leave “WIP” in the CL title until it is ready to review.
-* Make sure that `make buildall` succeeds after each individual change; this
- facilitates bisecting.
-* Assign reviewers with a specific scope for each reviewer.
- * Ideally one person will be qualified to review the entire CL; pick that
- person.
- * If multiple domain experts are required, indicate in the review request
- which parts each of them should review; don’t add a reviewer without a
- scope.
- * If someone needs to be aware that a change is happening, add them as CC; do
- this conservatively.
- * TODO: Use the attention set to clarify whose turn it is to respond, when
- that feature becomes available.
-* Consider multi-stage review: Get LGTM within a certain scope before moving to
- the next reviewer.
- * This may help reduce the number of patchsets and duplicated review effort.
- * It is probably most helpful when multiple reviewers should look at the same
- files.
- * Prioritize reviewers who may want fundamental changes, e.g. a component
- maintainer or domain expert should look at it before a language expert.
-* Keep related changes in a single relation chain if practical.
- * If not, consider using [topics][2] in Gerrit to group related CLs. For
- example, the topic ["CBI PCB supplier field"][6] links multiple CLs.
-* Try to make visible updates actionable for reviewers.
- * Don’t post a comment saying that you’ve done something before the patchset
- that does it.
- * Don’t post comments that say you’ll do something in the next patchset; just
- wait for that patchset.
- * If practical, don’t upload a new patchset until you can usefully respond to
- all unresolved comments.
- * Use `repo upload --no-emails` for patchsets that address comments before the
- responses to those comments.
- * Try to minimize rebases in the middle of a review; if practical, don’t
- rebase until just before submitting.
-* Try to make review comments maximally actionable for authors, who may be in
- different timezones or may be managing a relation chain with multiple
- reviewers.
- * Try to respond to review requests or follow-up comments within 1 business
- day.
- * This is an SLO for single responses, not the entire lifecycle of the CL.
- * Prefer to provide feedback on an entire CL in one shot, so that the author
- could plausibly respond to all of it and need no further review.
- * However, consider sending a reply after a partial review, if it would help
- keep the response time within 1 business day.
-* Resolve outstanding comments before submitting.
- * Don’t mark a comment as resolved until the question has been answered,
- request completed, concern assuaged, etc.
- * Typically, a reviewer should not CR+2 a CL until the reviewer’s comments
- have been resolved to their satisfaction. To reduce latency, a reviewer may
- CR+2 a CL with the stated assumption that the author will address
- outstanding minor comments; in this case, the author should resolve them
- before submitting.
-* Abandon changes that you don’t intend to keep working on. (`repo abandon`
- doesn’t do it on Gerrit.)
- * This should probably include CLs that, after review, you want to
- substantially rewrite or don’t expect to submit for a long time.
-
-### Guidelines for partner code reviews
-
-* Complete partner-internal code review (using Gerrit) before assigning to
- Google reviewers.
-* Send CLs to `cros-ec-reviewers@google.com` for review by default.
- * Or send to specific Googlers with domain expertise, consistent with above
- guidelines.
-
-### Guidelines for extended partner efforts
-
-* Discuss at the beginning of the effort which Googlers should review or be CCed
- on CLs.
- * Optionally create a [GWSQ][4] specific to the effort.
-
## Reference
+* [Chrome OS firmware review guidelines][2]
* [Coreboot Gerrit Guidelines][3]
* [Google small CL guidelines][5]
[1]: http://google3/chrome/crosinfra/gwsq/ec_reviewers
-[2]: https://gerrit-review.googlesource.com/Documentation/intro-user.html#topics
+[2]: http://chromium.googlesource.com/chromiumos/docs/+/master/firmware_code_reviews.md
[3]: https://doc.coreboot.org/getting_started/gerrit_guidelines.html
-[4]: https://g3doc.corp.google.com/gws/tools/gwsq/v3/g3doc/gerrit.md
[5]: https://google.github.io/eng-practices/review/developer/small-cls.html
-[6]: https://chromium-review.googlesource.com/q/topic:%2522CBI+PCB+supplier+field%2522