Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
c32bac13
Commit
c32bac13
authored
May 20, 2020
by
Thiago Figueiró
Committed by
Wayne Haber
May 20, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Use of conventional comments in code reviews
parent
6f044688
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
4 deletions
+5
-4
doc/development/code_review.md
doc/development/code_review.md
+5
-4
No files found.
doc/development/code_review.md
View file @
c32bac13
...
@@ -308,10 +308,11 @@ experience, refactors the existing code). Then:
...
@@ -308,10 +308,11 @@ experience, refactors the existing code). Then:
-
Seek to understand the author's perspective.
-
Seek to understand the author's perspective.
-
If you don't understand a piece of code, _say so_. There's a good chance
-
If you don't understand a piece of code, _say so_. There's a good chance
someone else would be confused by it as well.
someone else would be confused by it as well.
-
Do prefix your comment with "Not blocking:" if you have a small,
-
Ensure the author is clear on what is required from them to address/resolve the suggestion.
non-mandatory improvement you wish to suggest. This lets the author
-
Consider using the
[
Conventional Comment format
](
https://conventionalcomments.org#format
)
to
know that they can optionally resolve this issue in this merge request
convey your intent.
or follow-up at a later stage.
-
For non-mandatory suggestions, decorate with (non-blocking) so the author knows they can
optionally resolve within the merge request or follow-up at a later stage.
-
After a round of line notes, it can be helpful to post a summary note such as
-
After a round of line notes, it can be helpful to post a summary note such as
"LGTM :thumbsup:", or "Just a couple things to address."
"LGTM :thumbsup:", or "Just a couple things to address."
-
Assign the merge request to the author if changes are required following your
-
Assign the merge request to the author if changes are required following your
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment