From 47ea81efded98edc8133a9eac99869606f0a7ee1 Mon Sep 17 00:00:00 2001 From: mkanat Date: Thu, 5 Sep 2019 12:18:00 -0700 Subject: [PATCH] Internal change PiperOrigin-RevId: 267425726 --- review/developer/cl-descriptions.md | 2 +- review/developer/handling-comments.md | 2 +- review/developer/index.md | 2 -- review/developer/small-cls.md | 2 +- review/emergencies.md | 2 +- review/index.md | 2 +- review/reviewer/comments.md | 2 +- review/reviewer/index.md | 2 -- review/reviewer/looking-for.md | 2 +- review/reviewer/navigate.md | 2 +- review/reviewer/pushback.md | 2 +- review/reviewer/speed.md | 2 +- review/reviewer/standard.md | 2 +- 13 files changed, 11 insertions(+), 15 deletions(-) diff --git a/review/developer/cl-descriptions.md b/review/developer/cl-descriptions.md index 2975d7d..702dbd2 100644 --- a/review/developer/cl-descriptions.md +++ b/review/developer/cl-descriptions.md @@ -1,6 +1,6 @@ # Writing good CL descriptions -[TOC] + A CL description is a public record of **what** change is being made and **why** it was made. It will become a permanent part of our version control history, and diff --git a/review/developer/handling-comments.md b/review/developer/handling-comments.md index 9bcc6be..3f69603 100644 --- a/review/developer/handling-comments.md +++ b/review/developer/handling-comments.md @@ -1,6 +1,6 @@ # How to handle reviewer comments -[TOC] + When you've sent a CL out for review, it's likely that your reviewer will respond with several comments on your CL. Here are some useful things to know diff --git a/review/developer/index.md b/review/developer/index.md index 6538d36..6f3af55 100644 --- a/review/developer/index.md +++ b/review/developer/index.md @@ -1,7 +1,5 @@ # The CL author's guide to getting through code review -go/cl-author - The pages in this section contain best practices for developers going through code review. These guidelines should help you get through reviews faster and with higher-quality results. You don't have to read them all, but they are diff --git a/review/developer/small-cls.md b/review/developer/small-cls.md index c5ac41a..d7e5a0e 100644 --- a/review/developer/small-cls.md +++ b/review/developer/small-cls.md @@ -1,6 +1,6 @@ # Small CLs -[TOC] + ## Why Write Small CLs? {#why} diff --git a/review/emergencies.md b/review/emergencies.md index 580c34c..582562f 100644 --- a/review/emergencies.md +++ b/review/emergencies.md @@ -4,7 +4,7 @@ Sometimes there are emergency CLs that must pass through the entire code review process as quickly as possible. -[TOC] + ## What Is An Emergency? {#what} diff --git a/review/index.md b/review/index.md index 658e8f0..86d3823 100644 --- a/review/index.md +++ b/review/index.md @@ -10,7 +10,7 @@ At Google we use code review to maintain the quality of our code and products. This documentation is the canonical description of Google's code review processes and policies. -[TOC] + This page is an overview of our code review process. There are two other large documents that are a part of this guide: diff --git a/review/reviewer/comments.md b/review/reviewer/comments.md index 1a316c6..71693d2 100644 --- a/review/reviewer/comments.md +++ b/review/reviewer/comments.md @@ -1,6 +1,6 @@ # How to write code review comments -[TOC] + ## Summary diff --git a/review/reviewer/index.md b/review/reviewer/index.md index 2ce3d7d..29f234e 100644 --- a/review/reviewer/index.md +++ b/review/reviewer/index.md @@ -1,7 +1,5 @@ # How to do a code review -go/code-reviewer - The pages in this section contain recommendations on the best way to do code reviews, based on long experience. All together they represent one complete document, broken up into many separate sections. You don't have to read them diff --git a/review/reviewer/looking-for.md b/review/reviewer/looking-for.md index c42b582..875d633 100644 --- a/review/reviewer/looking-for.md +++ b/review/reviewer/looking-for.md @@ -1,6 +1,6 @@ # What to look for in a code review -[TOC] + Note: Always make sure to take into account [The Standard of Code Review](standard.md) when considering each of these diff --git a/review/reviewer/navigate.md b/review/reviewer/navigate.md index 98acf9c..4517a16 100644 --- a/review/reviewer/navigate.md +++ b/review/reviewer/navigate.md @@ -1,6 +1,6 @@ # Navigating a CL in review -[TOC] + ## Summary diff --git a/review/reviewer/pushback.md b/review/reviewer/pushback.md index 3cd11c8..54aa6ad 100644 --- a/review/reviewer/pushback.md +++ b/review/reviewer/pushback.md @@ -1,6 +1,6 @@ # Handling pushback in code reviews -[TOC] + Sometimes a developer will push back on a code review. Either they will disagree with your suggestion or they will complain that you are being too strict in diff --git a/review/reviewer/speed.md b/review/reviewer/speed.md index 47462b1..a4a9242 100644 --- a/review/reviewer/speed.md +++ b/review/reviewer/speed.md @@ -1,6 +1,6 @@ # Speed of Code Reviews -[TOC] + ## Why Should Code Reviews Be Fast? {#why} diff --git a/review/reviewer/standard.md b/review/reviewer/standard.md index 4e2b826..81b72fe 100644 --- a/review/reviewer/standard.md +++ b/review/reviewer/standard.md @@ -1,6 +1,6 @@ # The Standard of Code Review -[TOC] + The primary purpose of code review is to make sure that the overall code health of Google's code