登录查看更多内容

How do you review and provide feedback on test code written by your peers or juniors?

由人工智能和领英社区提供技术支持

Reviewing and providing feedback on test code written by your peers or juniors is an essential skill for any software developer who practices test driven development (TDD). TDD is a technique where you write automated tests before writing the actual code, and then refactor the code until it passes the tests. This way, you can ensure that your code meets the requirements, is clean and maintainable, and has fewer bugs. But how do you review and provide feedback on test code effectively and constructively? Here are some tips to help you.

此文章中的业界达人

由社区从 4 条内容中精选。了解更多

Nik Sumeiko

React/Nextjs, TDD, Clean Architecture made simple
Junilu Lacar

1 Follow a code review checklist

A code review checklist is a set of criteria that you can use to evaluate the quality and consistency of test code. It can cover aspects such as naming conventions, test structure, test coverage, assertions, readability, documentation, and error handling. You can use a standard checklist or create your own based on your project and team preferences. A code review checklist can help you focus on the most important aspects of test code, avoid missing any issues, and provide objective feedback.

添加您的观点

Nik Sumeiko

React/Nextjs, TDD, Clean Architecture made simple
举报内容
Here are the things I look for: - Unit tests have mocking of the inner code. It's a sign of a fragile test. It's always better to design the code so that a unit receives all side effects from the top (e.g., Dependency Injection). - Test description/subject is decoupled from the implementation details - Integration test captures a user journey

已翻译

赞
Junilu Lacar
举报内容
Overall, I look for the tests to tell a story that takes the reader on a journey to understanding. As Kent Beck once said, the story has to have an arc, a beginning, a middle, and an end. I also look for elements related to James Grenning's ZOMBIES and Tim Ottinger's Right-BICEP and CORRECT. I like to tell the story that I'm reading in the code back to the author so they can give feedback, correct misunderstandings, and fill in any gaps that need more context. For me, a code review is a telling and retelling of the story by the author, the reader, and the code. The goal is to align all three so everyone agrees we're telling the same story of what's going on.

已翻译

赞

2 Use a code review tool

A code review tool is a software application that facilitates the process of reviewing and commenting on test code. It can integrate with your version control system, such as Git, and allow you to compare different versions of test code, highlight changes, add annotations, suggest improvements, and track the status of feedback. Some examples of code review tools are GitHub, GitLab, Bitbucket, Gerrit, and CodeGuru. A code review tool can help you streamline the workflow of test code review, collaborate with your peers or juniors, and keep track of the feedback history.

添加您的观点

Md Maruf Rahman

ISTQB? Certified Tester | QA Automation Engineer | Cypress | WebdriverIO | Selenium |
举报内容
Using a code review tool is essential for providing feedback on test code written by peers or juniors. These tools, such as GitHub's pull request system or Atlassian's Bitbucket, allow for efficient and organized feedback. They provide a platform to review the code line by line, leave comments directly on specific sections, and discuss changes collaboratively. This ensures clarity in communication, maintains a record of feedback for future reference, and facilitates a smooth process for improving the quality of the test code.

已翻译

赞

3 Give constructive feedback

Constructive feedback is feedback that is specific, actionable, respectful, and positive, with the goal of helping the test code author improve their skills and code quality. When giving constructive feedback, you should begin by appreciating what the test code author did well. Focus on the test code and use objective and factual language; avoid personal or emotional statements. Provide examples and suggestions to explain why there are problems and how they can be solved. Ask questions to understand the test code author's perspective and reasoning, and encourage discussion by asking questions and inviting them to share their opinions and propose alternatives.

添加您的观点

4 Review your own feedback

Before sending your feedback to the test code author, you should review your own feedback and check if it meets the criteria of constructive feedback. You should also check if your feedback is clear, concise, and consistent. You can use tools such as Grammarly, Hemingway, or Code Spell Checker to help you with grammar, spelling, and style. You should also avoid using jargon, slang, or acronyms that the test code author may not understand. Reviewing your own feedback can help you avoid misunderstandings, errors, and conflicts.

添加您的观点

5 Follow up on feedback

After sending your feedback to the test code author, you should follow up on it and see if they have implemented it, responded to it, or asked for clarification. You should acknowledge their efforts, answer their questions, and resolve any disagreements. You should also be open to receiving feedback on your feedback and learn from it. Following up on feedback can help you build trust, rapport, and mutual learning with the test code author.

添加您的观点

6 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?

添加您的观点

Gareth Partridge

Senior Frontend Developer - React/Angular
举报内容
Something to look out for is a component unit test that has been intentionally written to maximise coverage and satisfy coverage reporting on tools, but fails to check the DOM. Too often I come across tests such as the above when carrying out code reviews. A coverage report may show 100% coverage because the test has successfully tested the logic and the code - however, the test will typically have failed to check that for example a heading has been shown in the DOM for said component. A reviewer should always look at the bigger picture. They should check that the test successfully checks that the component not only functions correctly but also displays correctly. Coverage is important but not the only factor to consider

已翻译

赞

Test Driven Development

+ 关注

给文章评分

我们借助人工智能创建了此文章。您认为这篇文章怎么样？

很棒不太好

举报此文章

查看全部

How do you review and provide feedback on test code written by your peers or juniors?

1

2

3

4

5

6

1 Follow a code review checklist

2 Use a code review tool

3 Give constructive feedback

4 Review your own feedback

5 Follow up on feedback

6 Here’s what else to consider

Test Driven Development

给文章评分

感谢您的反馈

更多Test Driven Development相关文章

更多相关阅读内容