greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: edit language for clarity, fix typos (#26438)

pull/34818/head
ChiselD 2019-01-05 21:48:12 +01:00 committed by Manish Giri
parent c3ec8babfc
commit 63f7f61026
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
guide/english/working-in-tech/code-reviews/index.md
View File

@ -3,22 +3,16 @@ title: Code Reviews
---
## Code Reviews
Code Reviews exist in order to improve the quality of the code in a software project and are common practice for many software development teams.
Code reviews involve team members looking into each others' code submissions to check for bugs, incorrect logic or
Code reviews exist in order to improve the quality of the code in a software project. They are common practice for many software development teams.
Code reviews involve team members looking at each other's code submissions to check for bugs, incorrect logic, and
potential improvements. A code review can be done amongst developers of the project under review, as well as developers from other teams in the same company.
To those who have not experienced the code review process before,
it can be intimidating. However, it is an invaluable process to help you
grow as a developer. 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))).
For those who have not experienced the code review process before, it can be intimidating. However, it is an invaluable process to help you grow as a developer. 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 encourages you to write better code in many ways (e.g. smaller methods, comments, 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. Teams, within an organization, create internal Coding Standards for the various languages used, as a guidance for developers, and code reviewers. An effective code review is one where functionality, testability, security, and readibility/styling issues are addressed.
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 dedicated to code reviews across the team. Teams, within an organization, create internal Coding Standards for the various languages used, as a guidance for developers, and code reviewers. An effective code review is one where functionality, testability, security, and readibility/styling issues are addressed.
It 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.
It 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.
#### More Information