added reviewer instructions for week-01 and week-02 #30
Conversation
royemosby
left a comment
royemosby
left a comment
There was a problem hiding this comment.
Content is good to go - I've formatted week 1 so it's a bit more formalized and resembles a dev ticket. We also need to move it over to the curriculum repo since this repo's for the students.
There was a problem hiding this comment.
Can you move all the reviewer guides over to the curriculum repo? We have a [folder there for mentor resources](https://github.com/Code-the-Dream-School/react-curriculum-v4/tree/main/mentor-content.
|
|
||
| This guide outlines what to check for when reviewing a student’s Week 01 submission. | ||
|
|
||
| ## ✅ What to Check |
There was a problem hiding this comment.
Let's go with a more formalized outline for the mentors using functional and technical specifications. Format should look something like:
Functional specifications:
- user requirements
- acceptance criteria
Technical specifications:
this is pretty open to interpretation per assignment but for us revolves around the specifics of implementation some possible things to include for exercise:
- component contents
- jsx structure
The Quality and Common Issues to Watch for are good sections to have too!
week 1 formatted:
Week 01 Exercises: About Me Page
Functional Specifications
User Requirements
- a user should be able to see a student's about me information, including a heading, an introductory paragraph and a list of hobbies/interests
Acceptance Criteria
- student work should only be in
src/exercises/week-01/studentWork.jsx - page should render with no errors
- page should display:
- personal heading
- introduction paragraph
- a list of hobbies/interests
- the weekly folder should include a screen capture of the rendered page (demonstrates that student is working with development server)
Technical Specifications
- component should include:
constfor their nameconstfor their ageconstfor their hobbies/interests in an array format (no need for each to have key since they're not using state)
- JSX should employ semantically appropriate HTML elements for each portion of their about me data. (h1, p, ol/ul, li, divs for organizing are optional)
- hobbies/interests should employ a
map
Quality
- Component exports correctly
- No unnecessary complexity (no hooks, props, styling etc.)
- JSX is valid and renders without errors
❌ Common Issues to Watch For
- Variables created outside the component
- Hobbies rendered manually instead of mapped
- Missing export statement
- Broken JSX or missing return statement
I went ahead and added the files completed files for week-01, week-02 and empty ready to go files for the rest of the weeks. I will from now on push instructions, student work and reviewer guide for each week.