Google Engineering Practices

https://google.github.io/eng-practices

Admin

Google Engineering Practices is a collection of generalized best practices documentation covering...

Tokens:5,101

Snippets:92

Trust Score:8.3

Update:2 months ago

Show doc for...

Tokens:

Raw

### Bad Response Example

Source: https://google.github.io/eng-practices/review/developer/handling-comments.html

An example of a non-collaborative, defensive response to a reviewer's comment.

```txt
Bad: “No, I’m not going to do that.”
```

--------------------------------

### CL Description Tagging Examples

Source: https://google.github.io/eng-practices/review/developer/cl-descriptions.html

Demonstrates various ways to incorporate tags into CL descriptions, including first-line usage and body placement.

```text
// Tags are okay in the first line if kept short.
[banana] Peel the banana before eating.

// Tags can be inlined in content.
Peel the #banana before eating.

// Tags are optional.
Peel the banana before eating.

// Multiple tags are acceptable if kept short.
#banana #apple: Assemble a fruit basket.

// Tags can go anywhere in the CL description.
> Assemble a fruit basket.
>
> #banana #apple
```

```text
// Too many tags (or tags that are too long) overwhelm the first line.
//
// Instead, consider whether the tags can be moved into the description body
// and/or shortened.
[banana peeler factory factory][apple picking service] Assemble a fruit basket.
```

--------------------------------

### Good Response Example

Source: https://google.github.io/eng-practices/review/developer/handling-comments.html

An example of a constructive, collaborative response that explains reasoning and invites further discussion.

```txt
Good: "I went with X because of [these pros/cons] with [these tradeoffs]
My understanding is that using Y would be worse because of [these reasons].
Are you suggesting that Y better serves the original tradeoffs, that we should
weigh the tradeoffs differently, or something else?"
```

Tokens:

Raw