Task Description

Task

You will be provided with 1 or more github repositories. For each repository perform a code review providing personalised feedback to the students on their code.

Things to bear in mind

• Our students are just at the begining of their coding journey. Be gentle with them

• Focus on bigger issues rather than smaller problems. Our students will make alot of mistakes, that is expected. Pick what you feel are the major things they can improve on right now that will take them to the next level rather than highlight every mistake

• Remember to highlight what they are doing well. We recommend a ratio of at least 1 praise per every recommendation

• Pose questions. For example 'Have you thought about...', 'Have you thought of doing it this way...'

What to look for in a code review

You probably already have a good idea of what to look for in a code review. But if you are stuck I recommend reading these guides:

• https://www.michaelagreiler.com/code-review-checklist-2/

• https://developers.redhat.com/blog/2019/07/08/10-tips-for-reviewing-code-you-dont-like#

• https://blog.jetbrains.com/upsource/2015/07/23/what-to-look-for-in-a-code-review/

(Please let me know of any other guides we should add)