Skip to content

Code Reviewer Guidance

Jump to bottom
Schuster edited this page Mar 15, 2023 · 2 revisions

Volunteer Code Reviewer Expectations for Vets Who Code

Thank you for volunteering to be a code reviewer for Vets Who Code. Your role is crucial in helping our student veterans learn valuable coding skills by ensuring quality of code.

Here are the expectations we have for our volunteer code reviewers:

  1. Be patient: Many of our student veterans are new to coding and may require extra guidance and feedback. Please take the time to provide thorough and clear feedback to help them learn and grow.

  2. Be constructive: While pointing out errors is important, it's equally important to offer suggestions and solutions for improvement. Our goal is to help our students become better coders, not to discourage them.

  3. Be timely: Aim to review pull requests within a reasonable timeframe, ideally within a few days of submission. Our students have deadlines to meet and your timely feedback is critical to their success.

  4. Be respectful: Remember that our students are veterans who have served our country and are now seeking to improve their lives through education. Constructive feedback should always be given in a respectful and professional manner.

Code reviews with Vets Who Code help students their improve communication skills. The practice of iterating on our code is central to the success of a developer. Code reviewers provide guidance to focus students on efforts that build value from iteration.

Clone this wiki locally