Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sub-section for review comment labeling in code review section #1732

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions content/en/contribute/code/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,16 @@ Once you are confident that the change is complete and ready to be merged:

The author and reviewer should use this [guide to code reviewing](https://google.github.io/eng-practices/review/developer/).

##### Labeling review comments

The reviewer should prefix labels in the review comments wherever possible. The labels could be `suggestion`, `issue`, `nitpick`, `question`, etc. that would clarify the intention of the comment and possibly remove any misunderstanding that might happen. It also helps the author in prioritizing the comments that they need to address. [More details here](https://conventionalcomments.org/).

Sample comments:

![Issue comment](issue-comment.png)

![Suggestion comment](suggestion-comment.png)

#### Suggestions

When doing a code review aim to be extremely clear. This helps things move quickly and avoids lost time in misunderstandings. One especially useful GitHub feature for doing this is suggesting a change. Consider the following example code:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.