Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an LO on code reviews #36

Open
damithc opened this issue Sep 21, 2017 · 0 comments
Open

Add an LO on code reviews #36

damithc opened this issue Sep 21, 2017 · 0 comments

Comments

@damithc
Copy link
Contributor

damithc commented Sep 21, 2017

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant