Skip to content

Add an LO on code reviews #36

@damithc

Description

@damithc

Possible content:

Here are some things you can comment on when reviewing code:

* Read the code from the perspective of a new developer. Identify parts that are harder to understand and suggest improvements.
* Point out any coding standard violations.
* Suggest better names for methods/variables/classes.
* Point out unnecessary code duplications.
* Check if the comments, docs, tests have been updated to match the code change.
* Check for violation of relevant principles such as the SOLID principles.
* Point out where SLAP can be improved. e.g. methods that are too long or has too deep nesting.
* Suggest any other code quality improvements.

*Resources*

* https://www.kevinlondon.com/2015/05/05/code-review-best-practices.html[Code Review Best Practices] - Blog post by Kevin London
* https://www.atlassian.com/agile/code-reviews[Why Code Reviews Matter] - An article by Atlassian

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions