Skip to content

Latest commit

 

History

History
81 lines (45 loc) · 2.74 KB

HOW_TO_REVIEW.md

File metadata and controls

81 lines (45 loc) · 2.74 KB
Raw

Everyone reviews code at CYF

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.

Key points:

  1. 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"

  2. 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."

  3. 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."

Labels

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.

Solutions

Where to find solutions?

Add -Solution to the end of a repo url to find the solution.

For this repo:

https://github.com/CodeYourFuture/JavaScript-Core-1-Coursework-Week1

Find the solution here:

https://github.com/CodeYourFuture/JavaScript-Core-1-Coursework-Week1-Solution

If you get a 404

Mentors: Join your Github Team - ask in Slack or look in the pinned posts in the top of your channel.

Trainees get solution repos one week later. Ask your mentors in Slack if you are getting a 404.

Using the Solutions Repo

Solutions repo typically contain:

Sample solutions

Solutions are example answers not the only correct answers.

Common responses guides.

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.

Guides

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:

https://teachertraining.codeyourfuture.io/tasks/code-review