Skip to content

Commit

Permalink
add sub-section for review comment labeling in code review section
Browse files Browse the repository at this point in the history
  • Loading branch information
sugat009 committed Dec 16, 2024
1 parent 54790cd commit 6ac8a40
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
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.

0 comments on commit 6ac8a40

Please sign in to comment.