Shulou(Shulou.com)06/01 Report--

In this article, the editor introduces in detail "what are the code review standards of Google", the content is detailed, the steps are clear, and the details are handled properly. I hope that this article "what are the code review standards of Google" can help you solve your doubts.

How to perform well in code review

In this article, we will briefly introduce 13 code review standards that can greatly help improve the health of your software and keep developers satisfied.

As the name implies, code review is a process in which one or more developers review or filter code written by another developer (author) to ensure that:

There are no errors or problems with the code.

Meet all quality requirements and standards.

The code performs the expected test.

After the merger, it will keep the code base in better health.

This is why code review is a key part of software development. The code reviewer acts as the code base administrator and is responsible for determining whether the code is in a state to be part of the code base and go into production.

Google is known for its excellent technology, and they have effective code review standards that seem to highlight some of the key points to keep in mind when reviewing code. At Google, the main purpose of code review is to ensure that the overall code performance of the Google code base improves over time.

This is a list of things to keep in mind when viewing the change list.

Review standard 1. The code improves the overall operation of the system.

Each change list (Pull Request) improves the overall health of the system. The idea is that with such small improvements, the health of the software or code base will improve after each merger.

two。 Quick code review, response and feedback

First, don't delay pushing (merging) better code. Don't expect the code to be perfect. If its condition can improve the overall operation of the system, please push.

"the key here is that there is no 'perfect' code, only better code."

If you are not in the middle of a priority task, check it immediately after the code is complete; however, a working day is the longest time it takes to respond to a pull request. It is expected that the change list will receive multiple rounds of partial / complete code reviews within one day.

3. Education and inspiration during code review

Provide guidance during code review by sharing knowledge and experience as much as possible.

4. Follow the standards when reviewing the code

Always keep in mind that documents such as coding standards are the absolute authority during code review. For example, to maintain consistency between tabs and spaces, you can reference coding conventions.

5. Resolve code review conflicts

Resolve conflicts by following best practices agreed in style guidelines and coding standards documentation and seeking advice from others with more knowledge and experience in the product area. Conflicts are handled differently according to their seriousness.

If your comments are optional or secondary, please explain them in the comments, and then it's up to the author to decide whether to resolve them or ignore them. As a code reviewer, you can at least recommend that the change list (request) be consistent with the rest of the code base in the absence of style guidelines or coding standards.

6. Demonstrate that UI changes are part of a code review

If the change list (Pull Request) changes the user interface, in addition to code review, you must demonstrate to ensure that all appearances on the appearance are as expected and match the simulation.

For the front-end change list (Pull Request), it is always recommended to conduct a demonstration / walkthrough, or to ensure that the change list also includes the necessary UI automated tests to verify the added / updated functionality.

7. Ensure that code review accompanies all tests

Unless there is an emergency, the pull request (change list) should be accompanied by all necessary tests, such as unit, integration, end-to-end, etc.

An emergency may be an error or security vulnerability that needs to be fixed as soon as possible, and tests can be added later. In this case, make sure that the appropriate issue is created and that someone has ownership immediately after completing the hot fix or deployment.

There is not enough reason to skip the test. If there is a risk that some goals will not be met due to time constraints, the solution is not to skip testing, but to define the scope of deliverables.

8. Don't disturb your code review when you're focused.

If you are in the middle of a priority, please do not disturb yourself, as it may take a long time to return to normal. In other words, the cost of interrupting a focused developer is much higher than having the developer wait for code review. Perform a code review after a scheduled break (such as lunch, coffee, etc.).

It is not always expected to complete and merge the entire code review process on the same day. It is important to give the author some feedback quickly. For example, you may not be able to do a complete check, but you can quickly point out something you can study. This will greatly reduce frustration during code review.

9. Review everything and don't make any assumptions.

View each line of code assigned to you for review. Don't make any assumptions about manually written classes and methods, and you should make sure you know what the code is doing.

Make sure you understand the code you are checking. If not, please clarify or ask for a code exercise / explanation. If you have parts of the code that are not qualified for review, make sure that there are other qualified developers who can review those parts of the code.

10. Take into account the overall situation when reviewing the code

Change is usually helpful in a broader context. For example, the file was changed and four lines of code were added. Don't just look at four lines of code; instead, consider looking at the entire file and checking for new additions. Will they reduce the quality of existing code, or will they make existing functionality a candidate for refactoring?

If you do not check such simple additions in the context of a function / method or class, over time, you will inherit a class that is unmaintainable, super complex, difficult to test, and all the work that cannot be done. and difficult to extend or ReFactor.

Keep in mind that over time, few improvements add up to produce a high-quality product with a minimum number of defects, and over time, slight code degradation or technical burden can also increase and make the product difficult to maintain and expand.

11. Recognize and encourage good work during code review

If you see something good in the change list, don't forget to shout out the author's excellent work and encourage them. This is something I have never done before. The purpose of code review should not only be to find errors, but also to encourage and guide developers to do good work.

twelve。 Be cautious, respectful, friendly and clear in code review

It is essential that you be kind, clear, polite and respectful during the code review, and be very clear and helpful to the author. When looking at the code, be sure to comment on the code, not the developer.

13. Explain your code review comments and keep in mind the scope

Whenever code review comments suggest alternatives or tags, it is important to explain why and provide examples based on your knowledge and experience to help developers understand how your suggestions will help improve code quality.

When recommending fixes or changes, find the right balance in how to guide the author to fix the code. For example, I appreciate guidance, explanations, tips or suggestions, rather than the whole solution.

After reading this, the article "what are the code review standards of Google" has been introduced. If you want to master the knowledge of this article, you still need to practice and use it yourself to understand it. If you want to know more about related articles, welcome to follow the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.