Introduce trainees to reviewing code

[illicitonion]

At some point we should introduce some basic "How to review code" / "What to look out for" kind of content for trainees. Ideally their first experience of reviewing code wouldn't be on a job.

In particular, we should talk a bit about how to review code a GenAI tool has produced.

[satwika2212]

Hi @illicitonion,
I’d love to take this! I can draft some basic “How to review code” content and include a part on reviewing GenAI-produced code. We could even add a few free exercises to make it more hands-on for trainees.

[illicitonion]

@satwika2212 That could be really useful, thank you!

Our general course structure is that we give people material to read (and we prefer linking to existing material rather than writing new material wherever possible), exercises to apply that learning, and often a 60-90 minute workshop where they will have mentors present to practice things in person.

We also already have a general guide to code review at https://curriculum.codeyourfuture.io/guides/reviewing/ but it's much more focused on guiding volunteers who already have experience with reviewing, and guiding trainees for how to have their code reviewed rather than how to give it.

If you can draft up some prep reading/links, and some exercises, we can work out where they would best fit into the curriculum! Thank you!

[satwika2212]

@illicitonion Sure, I like to do challenges! Quick question — when you say ‘volunteer’, do you mean a person, or could it also be a computer? I always thought volunteers are people, but just checking if it can be both here. And also, can you confirm whether the documents will be added only from the company side or admin side, and arranged topic-wise?and what changes do you need in the code? can youu describe muuch more breifly and can i write code in normal html instead of hugo templates?