From b70758322b980a81ddc2c24d61f69da9ff281b39 Mon Sep 17 00:00:00 2001 From: Paul Isaris Date: Mon, 15 Oct 2018 10:10:17 +0300 Subject: [PATCH] Enriched definition (#19014) * Enriched definition Added info about review results and common practices. * Fixed grammar mistakes Clarified the purpose of code reviews, re-written a sentence to improve it's clarity. --- .../guide/english/working-in-tech/code-reviews/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/client/src/pages/guide/english/working-in-tech/code-reviews/index.md b/client/src/pages/guide/english/working-in-tech/code-reviews/index.md index 16a5f788ef..94fd07611f 100644 --- a/client/src/pages/guide/english/working-in-tech/code-reviews/index.md +++ b/client/src/pages/guide/english/working-in-tech/code-reviews/index.md @@ -12,3 +12,10 @@ grow as a developer. Is is important to be humble throughout the code review process. Accept your mistakes, and be professional when pointing out improvements or errors in the code of your fellow team members. + +Code Reviews exist in order to improve the quality of the code in a software project. +A code review can be done amongst developers of the project under review, as well as developers from other teams in the same company. +Even if a review is just an explanation of the code to another programmer, the feeling that your code is going to be read/ inspected by another programmer as well makes you write better code in many ways (smaller methods, comments and no ["magic numbers"](https://en.wikipedia.org/wiki/Magic_number_(programming))). + +As to what is reviewed and when, well there is no clear answer. Many teams have rules that every piece of code that checks-in in the version control system has to be reviewed by another programmer, while other teams have whole days when they dedicate to code reviews across the team. +