liveBook · Manning

Expected issue

As explained in "Looks Good to Me"

A typical code-review problem that reviewers are expected to identify and discuss.

An expected issue is a typical problem reviewers are expected to identify and discuss during code review. These issues concern whether code will remain understandable, maintainable, secure, consistent, and workable at scale. section 4.4.4

Reviewers commonly look for:

  • Readability and maintainability problems that could make future changes difficult. section 4.4.4
  • Unnecessary complexity, including oversized classes, excessive layers, or abstractions that hide intent. section 4.4.4
  • Security vulnerabilities that could compromise systems or sensitive data. section 4.4.4
  • Code smells, misapplied patterns, unclear naming, inconsistent approaches, and performance problems at production scale. section 4.4.4

Keep obvious, mechanically detectable issues out of review when possible. If a problem repeatedly escapes linters or prechecks, monitor it and consider adding a linting rule or adjusting the checks. section 4.4.4

How "Looks Good to Me" covers it

How deep it goes
Defines major review categories and contrasts them with automatable obvious issues, but does not provide detailed remediation procedures.
Examples
Uses giant classes, excessive layers, lost intent, vulnerabilities, unclear names, inconsistent approaches, and production-scale performance as examples.
What you can do after
Evaluate code-review changes against recurring maintainability, complexity, security, consistency, naming, and performance concerns.
How it connects
Connects code review with readability, maintainability, complexity, security, code smells, design patterns, naming, performance, linting, and prechecks.
Cover of "Looks Good to Me"
liveBookmanning.com
Read "Looks Good to Me" on liveBook Get the book at manning.com

This explainer was generated by Manning's knowledge graph from the text of "Looks Good to Me". The section links point to the parts of the book it draws on.