document/eng-practices
2
0
Fork 0
mirror of https://github.com/eng-practices/eng-practices.git synced 2024-12-21 20:30:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Internal change

Browse Source 
PiperOrigin-RevId: 267425726
This commit is contained in:
mkanat 2019-09-05 12:18:00 -07:00 committed by Copybara-Service
parent 78ddc9e067
commit 47ea81efde
13 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
review/developer/cl-descriptions.md
View File

@ -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

2
review/developer/handling-comments.md
View File

@ -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

2
review/developer/index.md
View File

@ -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

2
review/developer/small-cls.md
View File

@ -1,6 +1,6 @@
# Small CLs
[TOC]
## Why Write Small CLs? {#why}

2
review/emergencies.md
View File

@ -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}

2
review/index.md
View File

@ -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:

2
review/reviewer/comments.md
View File

@ -1,6 +1,6 @@
# How to write code review comments
[TOC]
## Summary

2
review/reviewer/index.md
View File

@ -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

2
review/reviewer/looking-for.md
View File

@ -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

2
review/reviewer/navigate.md
View File

@ -1,6 +1,6 @@
# Navigating a CL in review
[TOC]
## Summary

2
review/reviewer/pushback.md
View File

@ -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

2
review/reviewer/speed.md
View File

@ -1,6 +1,6 @@
# Speed of Code Reviews
[TOC]
## Why Should Code Reviews Be Fast? {#why}

2
review/reviewer/standard.md
View File

@ -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