Don’t keep your code review comments for you

During a code review, you formulate comments that can address various topics:

readability
design & architecture
performance
framework or language usage

These explanations are insightful, but in most cases, they’ll only be read by the submitte…


This content originally appeared on DEV Community and was authored by Cédric Teyton

During a code review, you formulate comments that can address various topics:

  • readability
  • design & architecture
  • performance
  • framework or language usage

These explanations are insightful, but in most cases, they'll only be read by the submitter of the review. Once the review is over (and the Pull/Merge Request is closed), it's very seldom to retake a look at it afterward, and there's no capitalization on its knowledge.

However, most of your comments could be interesting for the other developers in the team and even for developers in other teams, with whom you may have no technical interactions daily. Also, it may not be the first time you formulate this comment, perhaps you already did on previous code reviews. Studies on code reviews reveals that reviewers feels tired due to repetitions effects.

That's why at Promyze, we designed web browser plugins integrated with GitHub, GitLab, BitBucket, and Azure DevOps, that allow you, when you write down a comment, to create a best practice and share it with your team.

Promyze_Code_Review

Your best practice will be sent to Promyze, reviewed by all your team, and then you'll easily reuse it during a code review thanks, to our plugins.

Also, other teams from your organization will have access to this best practice, and will be free to apply it in their context.

With Promyze, connect your developers' knowledge.


This content originally appeared on DEV Community and was authored by Cédric Teyton


Print Share Comment Cite Upload Translate Updates
APA

Cédric Teyton | Sciencx (2022-02-18T13:54:15+00:00) Don’t keep your code review comments for you. Retrieved from https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/

MLA
" » Don’t keep your code review comments for you." Cédric Teyton | Sciencx - Friday February 18, 2022, https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/
HARVARD
Cédric Teyton | Sciencx Friday February 18, 2022 » Don’t keep your code review comments for you., viewed ,<https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/>
VANCOUVER
Cédric Teyton | Sciencx - » Don’t keep your code review comments for you. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/
CHICAGO
" » Don’t keep your code review comments for you." Cédric Teyton | Sciencx - Accessed . https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/
IEEE
" » Don’t keep your code review comments for you." Cédric Teyton | Sciencx [Online]. Available: https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/. [Accessed: ]
rf:citation
» Don’t keep your code review comments for you | Cédric Teyton | Sciencx | https://www.scien.cx/2022/02/18/dont-keep-your-code-review-comments-for-you/ |

Please log in to upload a file.




There are no updates yet.
Click the Upload button above to add an update.

You must be logged in to translate posts. Please log in or register.