Mentors and trainees all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
We are not reviewing code as if we were to merge this PR into production; we are opening a technical conversation for the purpose of insight and development.
-
Ask questions instead of making statements:
YES: "Is there another element you could use to group a set of fields in a form? Why might someone use a different element in a form?" NO: "Use fieldset not divs"
-
Encourage simplicity, clarity, and precision:
YES "There are 15,0000 files in this changelist. Which files should be reviewed?" NO "It doesn't matter; I can try to figure out what you meant."
-
Respect everyone's work and time:
YES "I think there's some more to do here. Thanks for sharing where you're up to." NO "This is rubbish. Try harder."
Reviewers, please add labels (provided) to the PR once you've reviewed. This helps to focus the trainee on the areas they should work on, and gives an overview for mentors on what the whole cohort needs to work on.
You can find the solutions for the module on the solutions branch.
The solutions branch typically contains:
Solutions are example answers not the only correct answers.
Everyone is invited to contribute commonly encountered problems, mistakes, misunderstandings, and mental-model errors to our common responses documents.
Use these resources to inform your code review, get unstuck, and improve your understanding.
Here's a detailed checklist of the sorts of things we should check code for:
https://syllabus.codeyourfuture.io/guides/marking-guide
Here's a detailed style guide to help us all write clear, high quality code:
https://syllabus.codeyourfuture.io/guides/code-style-guide
Here's some help with giving good feedback during code review: